Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.25 KB

Policy.md

File metadata and controls

27 lines (18 loc) · 1.25 KB
Raw

This openZIM Python Bootstrap setup (main branch) represents the current recommendations for setting-up a Python project.

  • It should be used as base for any new Python project
  • It should serve as a reference to migrate older Python projects
  • Requirements for older projects are relaxed:
    • Static Type Checking:
      • pyright mode might be set to basic (with the typeCheckingMode parameter)
      • few # pyright: ignore comments are allowed in the code
    • Ruff rules:
      • # noqa: xxx comments can be placed when necessary
      • as a last resort (because it means that the situation might continue to get worse), some rule or groups might be completely commented in pyproject.toml
    • Cython-using projects should continue with setuptools/setup.py

Contributing

Discussions on significant improvements should happen via Opening an Issue.

Simpler suggestions are expected as Pull Request

Versioning

The Python policy / bootstrap / convention is versioned in the main CHANGELOG.md.

Tags are used to point to the various versions.

Project must specify in their README.md the version they currently support to track required changes.