Re: [DISCUSS] Introducing Typo CI Check to Apache BookKeeper
+1 Enrico Il giorno dom 26 mag 2024 alle ore 01:53 Hang Chen ha scritto: > +1 > > We need to keep an eye on the public methods and configurations. > > Best, > Hang > > Andrey Yegorov 于2024年5月22日周三 02:15写道： > > > > > > Awesome idea, thank you for tackling this. > > > > We need to keep an eye on changes in config parameter names in > yaml/configs to avoid unexpected breaks. > > So far I haven't noticed any, but it is an easy miss in a big PR. > > > > On 2024/05/19 07:20:30 ZhangJian He wrote: > > > 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 > created > > > a draft PR[2]. > > > > > > I have been careful to avoid changes to public interfaces, but I may > have > > > made mistakes, and the changes are relatively huge. 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 > > > 2. https://github.com/apache/bookkeeper/pull/4375/files > > > > > > Thanks > > > ZhangJian He > > > Twitter: shoothzj > > > Wechat: shoothzj > > > >
Re: [DISCUSS] Introducing Typo CI Check to Apache BookKeeper
+1 We need to keep an eye on the public methods and configurations. Best, Hang Andrey Yegorov 于2024年5月22日周三 02:15写道： > > > Awesome idea, thank you for tackling this. > > We need to keep an eye on changes in config parameter names in yaml/configs > to avoid unexpected breaks. > So far I haven't noticed any, but it is an easy miss in a big PR. > > On 2024/05/19 07:20:30 ZhangJian He wrote: > > 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 created > > a draft PR[2]. > > > > I have been careful to avoid changes to public interfaces, but I may have > > made mistakes, and the changes are relatively huge. 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 > > 2. https://github.com/apache/bookkeeper/pull/4375/files > > > > Thanks > > ZhangJian He > > Twitter: shoothzj > > Wechat: shoothzj > >
Re: [DISCUSS] Introducing Typo CI Check to Apache BookKeeper
Awesome idea, thank you for tackling this. We need to keep an eye on changes in config parameter names in yaml/configs to avoid unexpected breaks. So far I haven't noticed any, but it is an easy miss in a big PR. On 2024/05/19 07:20:30 ZhangJian He wrote: > 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 created > a draft PR[2]. > > I have been careful to avoid changes to public interfaces, but I may have > made mistakes, and the changes are relatively huge. 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 > 2. https://github.com/apache/bookkeeper/pull/4375/files > > Thanks > ZhangJian He > Twitter: shoothzj > Wechat: shoothzj >
[DISCUSS] Introducing Typo CI Check to Apache BookKeeper
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 created a draft PR[2]. I have been careful to avoid changes to public interfaces, but I may have made mistakes, and the changes are relatively huge. 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 2. https://github.com/apache/bookkeeper/pull/4375/files Thanks ZhangJian He Twitter: shoothzj Wechat: shoothzj
