Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Pull Request Template #1812

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!-- Delete Template sections if unneccesary -->
<!-- Add issue number here (We encourage you to create the Issue First) -->
<!-- You can also link the issue in Commit Messages -->

<!--
Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!
* [x] - Checked Box
* [ ] - Unchecked Box
-->

## What's this PR about?

<!-- Tell us what you've changed and why. -->

Fixes #0000

## What kind of change is this?

<!-- Check the boxes that apply to your PR -->
* [ ] Bug fix
* [ ] New feature
* [ ] Documentation update
* [ ] New importer pipeline ([How to add](https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_importer_pipeline.html))
* [ ] New improver pipeline ([How to add](https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_improver_pipeline.html))
* [ ] Code cleanup or performance improvement
* [ ] Other: _____

## Checklist before requesting a review

* [ ] read the [contribution guidelines](https://vulnerablecode.readthedocs.io/en/latest/contributing.html)
* [ ] code follows the project style
* [ ] titled PR clearly and linked the issue it resolves
* [ ] added tests for changes
* [ ] updated docs if needed
* [ ] updated the [CHANGELOG](https://github.com/aboutcode-org/vulnerablecode/blob/main/CHANGELOG.rst) if needed
* [ ] code passes all tests locally
* [ ] commits follow the [project's commit message style](https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html)

## AI assistance?

* [ ] used AI tools (like ChatGPT, Copilot, etc.) to help with this PR
* If yes, please share which parts: <!-- "Some code in file X," "documentation," etc. -->

## Anything else we should know?

<!-- Any extra context or screenshots that might help with the review -->

<!--
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
if your tests fail at first!
If tests do fail, click on the red `X` to learn why by reading the logs.
Thanks!
-->

<!-- Don't forget your sign-off! -->
Signed-off-by: YOUR NAME <YOUR_EMAIL>