Skip to content

Commit ca2c2af

Browse files
ahangarhaJudahmeek
authored andcommitted
Improve PR template
To ensure any PR makes: - update in changelog - add or update test to cover the new changes - update documentations
1 parent 28691a0 commit ca2c2af

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
### Summary
22

3-
Provide a general description of the code changes in your pull
3+
_Remove this paragraph and provide a general description of the code changes in your pull
44
request... were there any bugs you had fixed? If so, mention them. If
55
these bugs have open GitHub issues, be sure to tag them here as well,
6-
to keep the conversation linked together.
6+
to keep the conversation linked together._
77

88
### Other Information
99

10-
If there's anything else that's important and relevant to your pull
11-
request, mention that information here. This could include
12-
benchmarks, or other information.
10+
_Remove this parapraph and mention any other important and relevant information such as benchmarks._
1311

14-
If you are updating any of the CHANGELOG files or are asked to update the
15-
CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
12+
### Pull Request checklist
13+
_Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by `~`._
1614

17-
Thanks for contributing!
15+
- [ ] Add/update test to cover these changes
16+
- [ ] Update documentation
17+
- [ ] Update CHANGELOG file
18+
_Add the CHANGELOG entry at the top of the file._

0 commit comments

Comments
 (0)