Skip to content

Commit d19daae

Browse files
authored
chore: Improve usability and content of PR template (#993)
* chore: Add more type-of-change options in PRs I find myself often making changes not currently listed in the PR template types, so I've added them. Also added the Conventional Commit prefixes, to save having to check) * chore: Add whitespace in PR template for readability * chore: Add checkboxes to agree to terms in PRs * chore: Link to documentation & contributing guides
1 parent f657b31 commit d19daae

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

.github/pull_request_template.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,58 @@
11
<!--- Provide a general summary of your changes in the Title above -->
22

33
# Description
4+
45
<!--- Describe your changes in detail -->
56

67
## Motivation and Context
8+
79
<!--- Why is this change required? What problem does it solve? -->
810
<!--- If it fixes an open issue, please link to the issue here. -->
911

1012
## How has this been tested?
13+
1114
<!--- Please describe in detail how you tested your changes. -->
1215
<!--- Include details of your testing environment, tests ran to see how -->
1316
<!--- your change affects other areas of the code, etc. -->
1417

1518
## Screenshots (if appropriate)
1619

1720
## Types of changes
21+
1822
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
19-
- [ ] Bug fix (non-breaking change which fixes an issue)
20-
- [ ] Refactor (non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
21-
- [ ] New feature (non-breaking change which adds functionality)
22-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
23+
24+
Changes visible to users:
25+
26+
- [ ] **Bug fix** (prefix: `fix` - non-breaking change which fixes an issue)
27+
- [ ] **New feature** (prefix: `feat` - non-breaking change which adds functionality)
28+
- [ ] **Breaking change** (prefix: `feat!!` or `fix!!` - fix or feature that would cause existing functionality to not work as expected)
29+
- [ ] **Documentation** (prefix: `docs` - improvements to any documentation content)
30+
- [ ] **Sample vault** (prefix: `sample` - improvements to the sample vault)
31+
32+
Internal changes:
33+
34+
- [ ] **Refactor** (prefix: `refactor` - non-breaking change which only improves the design or structure of existing code, and making no changes to its external behaviour)
35+
- [ ] **Tests** (prefix: `test` - additions and improvements to unit tests and the smoke tests)
36+
- [ ] **Infrastructure** (prefix: `chore` - examples include GitHub Actions, issue templates)
2337

2438
## Checklist
39+
2540
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
2641
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
42+
2743
- [ ] My code follows the code style of this project and passes `yarn run lint`.
2844
- [ ] My change requires a change to the documentation.
29-
- [ ] I have updated the documentation accordingly.
30-
- [ ] My change has adequate Unit Test coverage.
45+
- [ ] I have [updated the documentation](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CONTRIBUTING.md#updating-documentation) accordingly.
46+
- [ ] My change has adequate [Unit Test coverage](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CONTRIBUTING.md#maintaining-the-tests).
47+
48+
## Terms
49+
50+
<!--
51+
By submitting this pull request, you must agree to follow our
52+
[contributing guide](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CONTRIBUTING.md) and
53+
[Code of Conduct](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CODE_OF_CONDUCT.md).
54+
Put an x in the boxes to confirm you agree.
55+
-->
3156

32-
By creating a Pull Request you agree to our [Code of Conduct](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CODE_OF_CONDUCT.md). For further guidance on contributing please see [contributing guide](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CONTRIBUTING.md)
57+
- [ ] My contribution follow this project's [contributing guide](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CONTRIBUTING.md)
58+
- [ ] I agree to follow this project's [Code of Conduct](https://github.com/obsidian-tasks-group/obsidian-tasks/blob/main/CODE_OF_CONDUCT.md)

0 commit comments

Comments
 (0)