Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 1.44 KB

python.md

File metadata and controls

23 lines (20 loc) · 1.44 KB

Python Checklist

This is a checklist for contributing Python example code to this repository.

  • Ideally examples are compatible with Python 3.10 and above.
  • Ideally the README.md and all other markdown documents should pass linting with pymarkdownlnt.
  • The code example should use some form of package manager and virtual environment.
  • The code must pass the following linter / type checkers:
    • Use Black code formatter with override of line length of 100.
      • black -l100 <filename.py>
    • Use Pylint with default configuration.
      • pylint <filename.py>
    • Use mypy with strict configuration.
      • mypy --strict <filename.py>
    • Use pydocstyle to help write more readable docstrings according to PEP 257.
      • pydocstyle <filename.py>

The CI script will automatically call the check_example script to activate supported virtual environments and run the linters. The check_example script can be called manually before committing changes or doing a pull request. All of the linters must pass before contribution can be merged.