56
edits
Changes
From Gramps
Elaborate on usage of Black
== Black ==
Gramps CI checks for code formatting compliance using [https://github.com/psf/black Black]. When 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, code and cannot be merged. Code which requires changes is shown in the Checks tab in the Lint panel. You may update the code manually Make changes required to make it pass, or integrate Black formatter with your preferred editor to ensure that the lint check will 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.
== Pylint ==