|
1 | 1 | <!-- |
2 | | -Before opening a PR, open a ticket describing the issue or feature the PR will address. Follow the steps in CONTRIBUTING.rst. |
| 2 | +Before opening a PR, open a ticket describing the issue or feature the |
| 3 | +PR will address. An issue is not required for fixing typos in |
| 4 | +documentation, or other simple non-code changes. |
3 | 5 |
|
4 | | -Replace this comment with a description of the change. Describe how it addresses the linked ticket. |
| 6 | +Replace this comment with a description of the change. Describe how it |
| 7 | +addresses the linked ticket. |
5 | 8 | --> |
6 | 9 |
|
7 | 10 | <!-- |
8 | | -Link to relevant issues or previous PRs, one per line. Use "fixes" to automatically close an issue. |
9 | | ---> |
| 11 | +Link to relevant issues or previous PRs, one per line. Use "fixes" to |
| 12 | +automatically close an issue. |
10 | 13 |
|
11 | | -- fixes #<issue number> |
| 14 | +fixes #<issue number> |
| 15 | +--> |
12 | 16 |
|
13 | 17 | <!-- |
14 | | -Ensure each step in CONTRIBUTING.rst is complete by adding an "x" to each box below. |
| 18 | +Ensure each step in CONTRIBUTING.rst is complete, especially the following: |
15 | 19 |
|
16 | | -If only docs were changed, these aren't relevant and can be removed. |
| 20 | +- Add tests that demonstrate the correct behavior of the change. Tests |
| 21 | + should fail without the change. |
| 22 | +- Add or update relevant docs, in the docs folder and in code. |
| 23 | +- Add an entry in CHANGES.rst summarizing the change and linking to the issue. |
| 24 | +- Add `.. versionchanged::` entries in any relevant code docs. |
17 | 25 | --> |
18 | | - |
19 | | -Checklist: |
20 | | - |
21 | | -- [ ] Add tests that demonstrate the correct behavior of the change. Tests should fail without the change. |
22 | | -- [ ] Add or update relevant docs, in the docs folder and in code. |
23 | | -- [ ] Add an entry in `CHANGES.rst` summarizing the change and linking to the issue. |
24 | | -- [ ] Add `.. versionchanged::` entries in any relevant code docs. |
25 | | -- [ ] Run `pre-commit` hooks and fix any issues. |
26 | | -- [ ] Run `pytest` and `tox`, no tests failed. |
0 commit comments