Python icon indicating copy to clipboard operation
Python copied to clipboard

Update developer toolset instructions in CONTRIBUTING.md

Open Cjkjvfnby opened this issue 3 years ago • 0 comments

Replace/remove instructions on individual tools usage with pre-commit. Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.

Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.

  • [ ] Add an algorithm?
  • [ ] Fix a bug or typo in an existing algorithm?
  • [x] Documentation change?

Checklist:

  • [x] I have read CONTRIBUTING.md.
  • [x] This pull request is all my own work -- I have not plagiarized.
  • [x] I know that pull requests will not be merged if they fail the automated tests.
  • [ ] This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • [ ] All new Python files are placed inside an existing directory.
  • [ ] All filenames are in all lowercase characters with no spaces or dashes.
  • [ ] All functions and variable names follow Python naming conventions.
  • [ ] All function parameters and return values are annotated with Python type hints.
  • [ ] All functions have doctests that pass the automated testing.
  • [ ] All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • [ ] If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

Cjkjvfnby avatar Oct 27 '22 21:10 Cjkjvfnby