From 239ab84a646c91102fceb4aa4b6d3f40c3e91694 Mon Sep 17 00:00:00 2001 From: Kevin Takla Date: Tue, 30 Apr 2024 13:48:38 -0400 Subject: [PATCH] ci: update pr template --- .github/PULL_REQUEST_TEMPLATE.md | 43 ++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 16 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6aaf21e..6025d3e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,4 @@ GitHub Issue: # - ## Proposed Changes @@ -13,27 +11,40 @@ GitHub Issue: # - [ ] Documentation content changes - [ ] Other, please describe: +## Description -## What is the current behavior? - + -## What is the new behavior? - +## Impact on version + +- [ ] **Major** (Public API was modified.) + - Public constructs (class, struct, delegate, enum, etc.) were removed or renamed. + - Public members were removed or renamed. + - Public method signatures were changed or renamed. +- [ ] **Minor** (Public API was extended.) + - Public constructs, members, or overloads were added. +- [ ] **Patch** (Public API was unchanged.) + - A bug in behavior was fixed. + - Documentation was changed. +- [ ] **None** (The library is unchanged.) + - Only code under the `build` folder was changed. + - Only code under the `.github` folder was changed. -## Checklist +## PR Checklist -Please check that your PR fulfills the following requirements: - -- [ ] Documentation has been added/updated. -- [ ] Automated tests for the changes have been added/updated. -- [ ] Updated [BREAKING_CHANGES.md](../BREAKING_CHANGES.md) (if you introduced a breaking change). - - +- [ ] Your conventional commits are aligned with the **Impact on version** section. +- [ ] Documentation is up to date. + - Content of `README.md` is up to date. + - XML documentation is up to date. +- [ ] The [BREAKING_CHANGES.md](../BREAKING_CHANGES.md) document is up to date. + - Create a new Major.0.0 header if you do a **Major** change and list the breaking changes. +- [ ] Tested on all relevant platforms ## Other information + +## Internal Issue (If applicable): + \ No newline at end of file