Skip to content

Commit 64382e3

Browse files
committed
Added a Pull Request Template
Signed-off-by: Rishi Garg <[email protected]>
1 parent 432a7d4 commit 64382e3

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<!--
2+
Thanks for submitting a pull request! Let's make VulnerableCode better together.
3+
Please fill out the info below to help us understand and review your changes.
4+
-->
5+
6+
<!-- Delete Template sections if unneccesary -->
7+
<!-- Add issue number here (We encourage you to create the Issue First) -->
8+
<!-- You can also link the issue in Commit Messages -->
9+
10+
<!--
11+
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
12+
* [x] - Checked Box
13+
* [ ] - Unchecked Box
14+
-->
15+
16+
## What's this PR about?
17+
18+
<!-- Tell us what you've changed and why. -->
19+
20+
Fixes #(issue number)
21+
22+
## What kind of change is this?
23+
24+
<!-- Check the boxes that apply to your PR -->
25+
* [ ] 🐛 Bug fix
26+
* [ ] ✨ New feature
27+
* [ ] 📚 Documentation update
28+
* [ ] 📥 New importer pipeline ([How to add](https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_importer_pipeline.html))
29+
* [ ] 🔧 New improver pipeline ([How to add](https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_improver_pipeline.html))
30+
* [ ] 🧹 Code cleanup or performance improvement
31+
* [ ] 🔄 Other: _____
32+
33+
## Checklist before requesting a review
34+
35+
* [ ] I've read the [contribution guidelines](https://vulnerablecode.readthedocs.io/en/latest/contributing.html)
36+
* [ ] My code follows the project style
37+
* [ ] I've titled my PR clearly and linked the issue it resolves
38+
* [ ] I've added tests for my changes
39+
* [ ] I've updated docs if needed
40+
* [ ] I've updated the [CHANGELOG](https://github.com/aboutcode-org/vulnerablecode/blob/main/CHANGELOG.rst) if needed
41+
* [ ] My code passes all tests locally
42+
* [ ] My commits follow the [project's commit message style](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html)
43+
44+
## AI assistance?
45+
46+
* [ ] I used AI tools (like ChatGPT, Copilot, etc.) to help with this PR
47+
* If yes, please share which parts: <!-- "Some code in file X," "documentation," etc. -->
48+
49+
Using AI is perfectly fine! We just need transparency so maintainers can review appropriately. This helps ensure the quality and security of our codebase.
50+
51+
## Anything else we should know?
52+
53+
<!-- Any extra context or screenshots that might help with the review -->
54+
55+
<!--
56+
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
57+
if your tests fail at first!
58+
If tests do fail, click on the red `X` to learn why by reading the logs.
59+
Thanks!
60+
-->
61+
62+
<!-- Don't forget your sign-off! -->
63+
Signed-off-by: YOUR NAME <YOUR_EMAIL>

0 commit comments

Comments
 (0)