From cf0a362fd9225f29e21376474ebb6b24523e985b Mon Sep 17 00:00:00 2001 From: Josh Wilson Date: Mon, 20 May 2024 09:45:19 +0900 Subject: [PATCH] chore: update PR template --- .github/PULL_REQUEST_TEMPLATE | 56 +++++++++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE index c479f24933..717181fa1d 100644 --- a/.github/PULL_REQUEST_TEMPLATE +++ b/.github/PULL_REQUEST_TEMPLATE @@ -1,3 +1,55 @@ -## Description +### Description -reviewpad:summary +Please provide a brief description of the changes made in this pull request. Highlight the purpose of the changes and the problem they address. + +### Related Issue + +Fixes # (if applicable). + +### Type of Change + +Please mark the types of changes made in this pull request. + +- [ ] Bug fix (non-breaking change which fixes an issue) +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Documentation update +- [ ] Other (please describe): + +### Checklist + +Please ensure all of the following tasks have been completed: + +- [ ] I have read the [contributing guidelines](CONTRIBUTING.md). +- [ ] I have performed a self-review of my own code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] New and existing unit tests pass locally with my changes. +- [ ] I have updated the documentation accordingly. +- [ ] I have followed the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for commit messages. +- [ ] I have verified my commit messages with [commitlint](https://commitlint.js.org/#/). + +