Skip to content

Commit 2272157

Browse files
committed
docs: add pull request template for better contributions
Signed-off-by: RISHI GARG <[email protected]>
1 parent cbda0ca commit 2272157

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
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 -->
4+
5+
<!--
6+
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
7+
* [x] - Checked Box
8+
* [ ] - Unchecked Box
9+
-->
10+
11+
## What's this PR about?
12+
13+
<!-- Tell us what you've changed and why. -->
14+
15+
Fixes #0000
16+
17+
## What kind of change is this?
18+
19+
<!-- Check the boxes that apply to your PR -->
20+
* [ ] Bug fix
21+
* [ ] New feature
22+
* [ ] Documentation update
23+
* [ ] New importer pipeline ([How to add](https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_importer_pipeline.html))
24+
* [ ] New improver pipeline ([How to add](https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_improver_pipeline.html))
25+
* [ ] Code cleanup or performance improvement
26+
* [ ] Other: _____
27+
28+
## Checklist before requesting a review
29+
30+
* [ ] read the [contribution guidelines](https://vulnerablecode.readthedocs.io/en/latest/contributing.html)
31+
* [ ] code follows the project style
32+
* [ ] titled PR clearly and linked the issue it resolves
33+
* [ ] added tests for changes
34+
* [ ] updated docs if needed
35+
* [ ] updated the [CHANGELOG](https://github.com/aboutcode-org/vulnerablecode/blob/main/CHANGELOG.rst) if needed
36+
* [ ] code passes all tests locally
37+
* [ ] commits follow the [project's commit message style](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html)
38+
39+
## AI assistance?
40+
41+
* [ ] used AI tools (like ChatGPT, Copilot, etc.) to help with this PR
42+
* If yes, please share which parts: <!-- "Some code in file X," "documentation," etc. -->
43+
44+
## Anything else we should know?
45+
46+
<!-- Any extra context or screenshots that might help with the review -->
47+
48+
<!--
49+
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
50+
if your tests fail at first!
51+
If tests do fail, click on the red `X` to learn why by reading the logs.
52+
Thanks!
53+
-->
54+
55+
<!-- Don't forget your sign-off! -->
56+
Signed-off-by: YOUR NAME <YOUR_EMAIL>

0 commit comments

Comments
 (0)