mozga-intel opened a new pull request #20429:
URL: https://github.com/apache/incubator-mxnet/pull/20429
## Description ##
There is used flake8' tool to perform additional formatting and semantic
checking of code. This pull request contains a pre-commit git hook, a
requirement file, .flake8 file with a flake8 configuration.
1. Since Flake8 needs to be installed with an appropriate configuration, the
file with the requirements has to be run:
```
pip install -r requirements-flake8.txt
```
2. After that, we need to set up a symbolic link to a given file: To create
a symbolic link to a given file, open your terminal and type:
```
ln -s ../../tools/git-pre-commit .git/hooks/pre-commit
```
3. If you have not set up the pre-commit hooks, you can run it locally in
your local branch.
## Future consideration ##
1. Flake8 tool should be run also on a CI.
2. *.py files need to be adjusted firstly. Flake8 check the entire file.
3. Add a pre-commit configuration: [pre-commit manager]
3.1: Create a file named `.pre-commit -config.yaml`.
3.2: Set up the full set of options for a given file.
## Checklist ##
### Essentials ###
- [ ] PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL],
[FEATURE], [DOC], etc)
- [ ] Changes are complete (i.e. I finished coding on this PR)
- [ ] All changes have test coverage
- [ ] Code is well-documented
### Changes ###
- [ ] Feature1, tests, (and when applicable, API doc)
- [ ] Feature2, tests, (and when applicable, API doc)
## Comments ##
- If this change is a backward incompatible change, why must this change be
made.
- Interesting edge cases to note here
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
