From 761d30d9986d6552e771a6f0e94cefe58259d3c1 Mon Sep 17 00:00:00 2001 From: Drew Date: Mon, 22 Oct 2018 14:22:55 -0400 Subject: [PATCH] [template]: Reorder pull request template PR template wasn't in a logical order, hard for maintainers to read. Reorganized. Fix directory where docs are built from. Signed-off-by: Drew Risinger --- .github/pull_request_template.md | 58 ++++++++++++++++---------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 22b5b9ba2..7c50ac1cd 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -12,35 +12,6 @@ Based on https://raw.githubusercontent.com/PyCQA/pylint/master/.github/PULL_REQU # ARTIQ Pull Request -## Steps (Choose relevant, delete irrelevant before submitting) - -### All Pull Requests - -- [x] Use correct spelling and grammar. -- [ ] Update [RELEASE_NOTES.md](../RELEASE_NOTES.md) if there are noteworthy changes, especially if there are changes to existing APIs. -- [ ] Close/update issues. -- [ ] Check the copyright situation of your changes and sign off your patches (`git commit --signoff`, see [copyright](../CONTRIBUTING.rst#copyright-and-sign-off)). - -### Code Changes - -- [ ] Run `flake8` to check code style (follow PEP-8 style). `flake8` has issues with parsing Migen/gateware code, ignore as necessary. -- [ ] Test your changes or have someone test them. Mention what was tested and how. -- [ ] Add and check docstrings and comments -- [ ] Check, test, and update the conda recipes in [conda/](../doc/) -- [ ] Check, test, and update the [unittests in /artiq/test/](../artiq/test/) or [gateware simulations in /artiq/gateware/test](../artiq/gateware/test) - -### Documentation Changes - -- [ ] Check, test, and update the documentation in [doc/](../doc/). Build documentation (`cd doc; make html`) to ensure no errors. - -### Git Logistics - -- [ ] Split your contribution into logically separate changes (`git rebase --interactive`). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See [tutorial](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase). -- [ ] Write short & meaningful commit messages. Review each commit for messages (`git show`). Format: - ``` - [topic]: description. < 50 characters total. - Longer description. < 70 characters per line - ``` ## Description of Changes ### Related Issue @@ -62,6 +33,35 @@ Closes #XXX | ✓ | :hammer: Refactoring | | ✓ | :scroll: Docs | +## Steps (Choose relevant, delete irrelevant before submitting) + +### All Pull Requests + +- [x] Use correct spelling and grammar. +- [ ] Update [RELEASE_NOTES.md](../RELEASE_NOTES.md) if there are noteworthy changes, especially if there are changes to existing APIs. +- [ ] Close/update issues. +- [ ] Check the copyright situation of your changes and sign off your patches (`git commit --signoff`, see [copyright](../CONTRIBUTING.rst#copyright-and-sign-off)). + +### Code Changes + +- [ ] Run `flake8` to check code style (follow PEP-8 style). `flake8` has issues with parsing Migen/gateware code, ignore as necessary. +- [ ] Test your changes or have someone test them. Mention what was tested and how. +- [ ] Add and check docstrings and comments +- [ ] Check, test, and update the conda recipes in [conda/](../doc/) +- [ ] Check, test, and update the [unittests in /artiq/test/](../artiq/test/) or [gateware simulations in /artiq/gateware/test](../artiq/gateware/test) + +### Documentation Changes + +- [ ] Check, test, and update the documentation in [doc/](../doc/). Build documentation (`cd doc/manual/; make html`) to ensure no errors. + +### Git Logistics + +- [ ] Split your contribution into logically separate changes (`git rebase --interactive`). Merge/squash/fixup commits that just fix or amend previous commits. Remove unintended changes & cleanup. See [tutorial](https://www.atlassian.com/git/tutorials/rewriting-history/git-rebase). +- [ ] Write short & meaningful commit messages. Review each commit for messages (`git show`). Format: + ``` + [topic]: description. < 50 characters total. + Longer description. < 70 characters per line + ``` ### Licensing