[GitHub] [apisix] jbampton edited a comment on pull request #3624: feat: add pre-commit framework

[GitBox <gi...@apache.org>]

jbampton edited a comment on pull request #3624:
URL: https://github.com/apache/apisix/pull/3624#issuecomment-832391304


   Hey @Yiyiyimu can you please review ?
   
   I have removed all the Python checks from the pre-commit and I have removed the original GitHub Actions for markdownlint and yamlint.  I added pre-commit to the CI.
   
   I added a new check to pre-commit called codespell which found some more spelling mistakes and we now have a small custom dictionary.  I cleaned up the lint file removing the emoji since I think it might look better.
   
   pre-commit has a check for trailing whitespace but it doesn't not give us as much coverage as our custom GitHub action since with pre-commit we ignore the file but with actions we ignore lines in that file.  Still good to at least have a check on pre-commit for trailing whitespace.  You can even write your own hook scripts and on Apache Airflow they write them in Shell and Python. 
   
   Pre-commit can be installed with `pip`, `curl`, `brew` or `conda` so maybe we should leave it up to the user to install since they might prefer a certain way.    I am willing to add some more docs too.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org