diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 9579226a94..02fc89f7c7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,29 +1,28 @@ ## Description - + ## Related Issue - ## Type of Change - - -- [ ] ๐Ÿ“š 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 - +## ๐Ÿงช Testing + -- [ ] 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 +