diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9abf2cdbd..42cd8169b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,11 @@ ## Description + +Fixes #X. + (...) -Fixes #(insert issue number here if applicable) +## To Do -## TODO -- [ ] docs - If you've added a new command flag, for example, find the appropriate page under docs/ where it needs to be listed -- [ ] Add a changelog entry to docs/changelog.rst near the top of the document. -- [ ] Add tests (suggested, but not a hard requirement) +- [ ] Documentation. (If you've add a new command-line flag, for example, find the appropriate page under `docs/` to describe it.) +- [ ] Changelog. (Add an entry to `docs/changelog.rst` near the top of the document.) +- [ ] Tests. (Encouraged but not strictly required.)