Skip to content

chore: improve PR template with testing and reviewer notes sections #2209

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: improve PR template with testing and reviewer notes sections #2209

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 15 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,28 @@
## Description

<!-- Add a more detailed description of the changes if needed. -->
<!-- Add a detailed description of the changes if needed. -->

## Related Issue

<!-- If your PR refers to a related issue, link it here. -->

## Type of Change

<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->

- [ ] 📚 Examples / docs / tutorials / dependencies update
- [ ] 🔧 Bug fix (non-breaking change which fixes an issue)
- [ ] 🥂 Improvement (non-breaking change which improves an existing feature)
- [ ] 🚀 New feature (non-breaking change which adds functionality)
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to change)
- [ ] 📚 Docs / examples update
- [ ] 🔧 Bug fix (non-breaking change)
- [ ] 🥂 Improvement
- [ ] 🚀 New feature
- [ ] 💥 Breaking change
- [ ] 🔐 Security fix

## Checklist
- [ ] I’ve read the CODE_OF_CONDUCT.md
- [ ] I’ve followed CONTRIBUTING.md
- [ ] I’ve written tests for new functionality
- [ ] I’ve updated documentation where necessary
- [ ] I’ve run `pdm update-lock` if dependencies were modified

<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->
## 🧪 Testing
<!-- Explain how you tested your changes -->

- [ ] I've read the [`CODE_OF_CONDUCT.md`](https://github.com/Giskard-AI/ai-inspector/blob/master/CODE_OF_CONDUCT.md) document.
- [ ] I've read the [`CONTRIBUTING.md`](https://github.com/Giskard-AI/ai-inspector/blob/master/CONTRIBUTING.md) guide.
- [ ] I've written tests for all new methods and classes that I created.
- [ ] I've written the docstring in Google format for all the methods and classes that I used.
- [ ] I've updated the `pdm.lock` running `pdm update-lock` (only applicable when `pyproject.toml` has been
modified)
## 🧑‍💻 Reviewer Notes
<!-- Add any special instructions or things reviewers should focus on -->