|
1 | 1 | Provide a narrative description of what you are trying to accomplish:
|
2 | 2 |
|
3 |
| -- Are you fixing a bug? |
4 |
| - - Detail how the bug is invoked currently. |
5 |
| - - Detail the original, incorrect behavior. |
6 |
| - - Detail the new, expected behavior. |
| 3 | +- [ ] Are you fixing a bug? |
| 4 | + - [ ] Detail how the bug is invoked currently. |
| 5 | + - [ ] Detail the original, incorrect behavior. |
| 6 | + - [ ] Detail the new, expected behavior. |
| 7 | + - [ ] Base your feature on the `master` branch, and submit against that branch. |
| 8 | + - [ ] Add a regression test that demonstrates the bug, and proves the fix. |
| 9 | + - [ ] Add a `CHANGELOG.md` entry for the fix. |
7 | 10 |
|
8 |
| -- Are you creating a new feature? |
9 |
| - - Why is the new feature needed? What purpose does it serve? |
10 |
| - - How will users use the new feature? |
| 11 | +- [ ] Are you creating a new feature? |
| 12 | + - [ ] Why is the new feature needed? What purpose does it serve? |
| 13 | + - [ ] How will users use the new feature? |
| 14 | + - [ ] Base your feature on the `develop` branch, and submit against that branch. |
| 15 | + - [ ] Add only one feature per pull request; split multiple features over multiple pull requests |
| 16 | + - [ ] Add tests for the new feature. |
| 17 | + - [ ] Add documentation for the new feature. |
| 18 | + - [ ] Add a `CHANGELOG.md` entry for the new feature. |
11 | 19 |
|
12 |
| -- Is this related to quality assurance? |
13 |
| - - Detail why the changes are necessary. |
| 20 | +- [ ] Is this related to quality assurance? |
| 21 | + <!-- Detail why the changes are necessary --> |
14 | 22 |
|
15 |
| -- Is this related to documentation? |
16 |
| - - Is it a typographical and/or grammatical fix? |
17 |
| - - Is it new documentation? |
| 23 | +- [ ] Is this related to documentation? |
| 24 | + <!-- Is it a typographical and/or grammatical fix? --> |
| 25 | + <!-- Is it new documentation? --> |
0 commit comments