diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 28eea257a..4cf8375ad 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,15 +1,25 @@ -# Proposed Changes +## Description (Proposed Changes) +(Please try to mention in bullet points.) -- - - -Related Issues (if applicable) +## Link to the issue : -- +(Add link of the issue you have proposed changes to) + +- Link : + +## Tests + +Please make sure to add tests when implementing new features. + +## Checklist -## Please check that the PR fulfills these requirements +Please check that the PR fulfills all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process. - [ ] Set a 100 character limit in your editor/IDE to avoid white space diffs in the PR - [ ] Tests for the changes have been added (for bug fixes / features) - [ ] Added yourself to AUTHORS.md +- [ ] Updated/added relevant documentation (doc comments with `///`). +- [ ] Added relevant reviewers.