Open main menu

Gramps β

Changes

Programming guidelines

No change in size, 9 April
m
move punctuation within URL
Gramps CI checks for code formatting compliance using [https://github.com/psf/black Black].
Black can be installed as a [https://github.com/psf/black/releases/ standalone tool] on the system, as a [https://pypi.org/project/black/ Python PIP package,], or as a plugin/integration to many IDEs. Follow the [https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html usage instructions] on the Black docs to validate your file changes. Doing this prior to creating the Pull Request ensures that it will pass the lint check.
If code in a PR violates formatting rules the PR fails the CI check, and cannot be merged. Code which requires changes is shown in the Checks tab in the Lint panel. Make changes required to make the lint check pass. Sometimes the changes are not visible because they are white space violations, so look carefully. When using Black locally, use the same version as the CI system to ensure formatting consistency.
56
edits