Skip to content

Commit 835ea87

Browse files
committed
update PR template
Signed-off-by: dotarjun <[email protected]>
1 parent 96bbdc7 commit 835ea87

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,29 @@
1-
# Description
2-
<!-- Please include a summary of the change and relevant motivation and context. -->
3-
Fixes # (issue)
1+
<!-- Delete Template sections if unneccesary -->
2+
<!-- Add issue number here (We encourage you to create the Issue First) -->
3+
<!-- You can also link the issue in Commit Messages -->
44

5-
# Type of change
6-
<!-- Please delete options that are not relevant. -->
7-
[ ] Bug fix (non-breaking change which fixes an issue)
8-
[ ] New feature (non-breaking change which adds functionality)
9-
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
5+
Fixes #0000
106

11-
# Checklist
12-
[ ] My code follows the style guidelines of this project
13-
[ ] I have performed a self-review of my own code
14-
[ ] I have commented my code, particularly in hard-to-understand areas
15-
[ ] I have made corresponding changes to the documentation
16-
[ ] My changes generate no new warnings
17-
[ ] Any dependent changes have been merged and published in downstream modules
7+
<!--
8+
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
9+
* [x] - Checked Box
10+
* [ ] - Unchecked Box
11+
-->
1812

19-
# Screenshots (if appropriate)
13+
### Tasks
2014

21-
# Other information
22-
<!-- Please add any other relevant information or screenshots about the change here. -->
15+
* [ ] Reviewed [contribution guidelines](https://github.com/nexB/scancode-toolkit/blob/develop/CONTRIBUTING.rst)
16+
* [ ] PR is descriptively titled and links the original issue above.
17+
* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
18+
Run [tests](https://github.com/nexB/scancode-workbench?tab=readme-ov-file#testing) locally to check for errors.
19+
* [ ] Commits are in uniquely-named feature branch and has no merge conflicts
20+
* [ ] Looked for possible updates in documentation and added updates if applicable
21+
* [ ] Updated CHANGELOG.rst
22+
<!--
23+
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
24+
if your tests fail at first!
25+
If tests do fail, click on the red `X` to learn why by reading the logs.
26+
Thanks!
27+
-->
28+
29+
<!-- Don't forget to Signoff -->

0 commit comments

Comments
 (0)