This section covers the pull request guidelines.
Pull Request guidelines are in place in order to maintain consistency and clearly communicate our process for processing merges into the master branch.
- Ensure the
Allow edits by maintainerscheckbox is checked due to our Squash Merge policy
- Ensure you avoid a force push due to our Squash Merge policy and Review complications
Every Pull Request will be squash merged into master. This requires the Pull Request branch to be up-to-date with the master branch.
Every Pull Request will undergo a formal review process. This process is heavily complicated if you rewrite history
and/or perform a force push, especially after a maintainer has started a review. As such we request that any action that
origin/master into your branch to synchronize your commit after the initial review and any other action that
The following requirements must be met for a pull request to be accepted. This list also acts as a checklist for maintainers in their review process.
- The changes must be documented if they add or change behaviour
- The changes must meet the following guidelines:
- The changes adhere to all of the relevant linting and quality testing automations
- The pull request closes related issues by mentioning them appropriately
- The contribution adhere to the security by design principles by:
- Setting secure defaults
- Disallows critically insecure settings
- Requires explicit awareness by users that specific settings may reduce security
- Potential future items:
- Contribution includes DCO
- Contribution includes REUSE-compliance requirements