Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

51 lines (37 loc) · 2.22 KB

Contributing

We welcome contributions in several forms, e.g.

  • Documenting
  • Testing
  • Coding
  • Reproducing Bugs

Please check Issues and look for unassigned ones or create a new one.

Guidelines

Workflow

  • Base pull requests on top of the latest main branch.
  • Pull requests must be rebased to the main branch before merging. We use fast-forward merges and squashing without creating merge commits to achieve a linear history.
  • Follow our commit message style for the title and description of your pull request. This allows maintainers to use your title and description of the pull request as commit message.
  • We tag releases on the main branch.
  • CI checks must succeed before merging to main.
  • A maintainer listed in CODEOWNERS must review and merge the pull request.

Commit Message

We follow the commit message style of cbeams. The style in summary is:

  1. Separate subject from body with a blank line
  2. Limit the subject line to 50 characters
  3. Capitalize the subject line
  4. Do not end the subject line with a period
  5. Use the imperative mood in the subject line
  6. Wrap the body at 72 characters
  7. Use the body to explain what and why vs. how

Commit messages on pull requests can deviate from this style, because commits get squashed when merged to main and maintainers can override the commit message. However, give your pull request a subject and body in this style. Commits on the main branch must follow this styleguide!

Commit messages must have a Signed-off-by trailer certifying that the committer has the rights to submit the work under the project's license and agrees to the Developer Certificate of Origin

Codestyle

For filetypes not listed below follow the generic settings in .editorconfig.

Python

We follow the Ruff Formatter style, which is enforced in CI.

Markdown

We use one line per sentence, and therefore don't enforce a maximum line-length for .md files. This keeps diffs cleaner and helps to quicker understand the structure of a paragraph when reading the raw .md file.