CONVENTIONS.md

Coding conventions

Code must be PEP8 compliant with the exception of allowing for line lengths up to 110 characters. Compliance is enforced using ruff

Run ruff to check that your code conforms before pushing code to the repository:

make lint

Or enforce by running scripts/lint.sh as part of your ci/cd pipeline.

Branch naming conventions

Branches must be named in accordance with the rules specified in .githooks/pre-push.

• branch names should be informative, meaningful and concise.
• branch names should follow the pattern (category)/(description)/(ticket number)

# Enforce branch naming conventions for this project using git hooks.
git config core.hooksPath .githooks

example of a good branch name:

# Task related to re-factoring of logging, the ticket number being 123:
task/re-factor-logging/123

example of a bad branch name:

wps-123