This proposal looks good to me. I used typos for many projects and it helps to avoid trivial typos and what's more valuable, avoid typos in public methods or fields [1] 🤣
[1] https://github.com/pravega/pravega/blob/a5cbd812dbc9705d24361ba3141277dfbd5bccdd/shared/controller-api/src/main/proto/Controller.proto#L35-L37 Best, tison. ZhangJian He <shoot...@gmail.com> 于2024年5月19日周日 15:28写道： > Hi, I want to introduce new lint tools: typos[1]. This tool is designed to > automatically detect and correct typographical errors in our codebase, > documentation, and comments. It’s a valuable addition to ensure > high-quality contributions and maintain the professional standard of our > project. > > It has also been used in the Apache OpenDAL and Kvrocks projects. > > I know I should avoid changes to public interfaces, but I may have made > mistakes, and the changes are relatively huge. I tried the tool locally and > found 600+ errors. I think I would prefer to proceed as follows: > > • First, commit typos in Markdown, YAML, etc. > • Second, commit typos in test files. > • Lastly, fix other typos and commit the lint. > > > 1. https://github.com/crate-ci/typos > > > Thanks > ZhangJian He > Twitter: shoothzj > Wechat: shoothzj >
