Skip to main content

Coding Guidelines

Before implementing a major change, please reach out to the maintainers by opening an issue. This allows us to discuss your idea before your spend too much time on it.

Coding style:

  • Auto-format your code.

Using git:

  • Write clear commit messages.
  • Structure your code into distinct, logically arranged commits.
  • While working on a private branch, you can amend commits and rebase your branch on master/main as often as you like, to create a clean history. Be careful when force-pushing afterwards. Never rewrite the public default branch!
  • Make separates branches and MRs for separate things. This makes it easier to review and merge changes.