pull_request_template.md
May 18, 2026 · View on GitHub
Please read Github PR Conventions and then fill in one of these two templates.
Template Α: This PR modifies behaviour or interface
Include the following checklist in your PR:
- Patches conform to the coding conventions.
- Any changes that could be relevant to users have been recorded in the changelog.
- Is the change significant? If so, remember to add
significance: significantin the changelog file.
- Is the change significant? If so, remember to add
- The documentation has been updated, if necessary.
- Manual QA notes have been included.
- Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)
Template B: This PR does not modify behaviour or interface
E.g. the PR only touches documentation or tests, does refactorings, etc.
Include the following checklist in your PR:
- Patches conform to the coding conventions.
- Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).