Skip to content

Coding guidelines

Please do:

  • use the common sense,
  • add tests along with the new code that prove that it works:
    • when adding/changing non-trivial logic please add unit tests,
    • for all bug fixes and new features using GitLab API please add acceptance tests
  • use INFO as the base log level, DEBUG only if you might expose sensitive information (such as raw API request/responses)
    • Logging levels information
    • by default we log WARNING and above issues; INFO is logged when specifying the --verbose argument in CLI
    • diff output is emitted via a dedicated DIFF log level and does not require --verbose
    • use the logging module for logging, do not use print statements
    • we have a custom log level for "diff" messages, used only in the difference_logger
    • we have a custom log level "notice" used only in gitlabform.__init__ in order to output version information and the total numbers of Projects/Groups processed
  • add or update the docs for new features,
  • use pre-commit to automatically reformat your code and run linters before committing,
  • squash your commits (unless there is a reason not to),
  • follow conventional-commit format in order to produce consistent human and machine-readable commit messages, making it easier for maintainers to produce the CHANGELOG.

We are very open to refactoring but in case of bigger efforts we suggest creating an issue first and discussing what you propose to do before doing it.