From 65e0c7f203b9024b1c869bf17bf4b5cefc5dc49a Mon Sep 17 00:00:00 2001 From: MisRob Date: Fri, 13 Oct 2023 12:52:24 +0200 Subject: [PATCH] Add changelog section to PR template --- .github/pull_request_template.md | 26 +++++++++++++++++++++++++- CHANGELOG.md | 4 ++-- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 33bbe7805..e79d549ef 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,6 +11,26 @@ Addresses #*PR# HERE* ### Before/after screenshots +## Changelog + + + +- [#PR no] + - **Description:** Summary of change(s) + - **Products impact:** Choose from - none (for internal updates) / bugfix / new API / updated API / removed API. If it's 'none', use "-" for all items below to indicate they are not relevant. + - **Addresses:** Link(s) to GH issue(s) addressed. Include KDS links as well as links to related issues in a consumer product repository too. + - **Components:** Affected public KDS component. Do not include internal sub-components or documentation components. + - **Breaking:** Will this change break something in a consumer? Choose from: yes / no + - **Impacts a11y:** Does this change improve a11y or adds new features that can be used to improve it? Choose from: yes / no + - **Guidance:** Why and how to introduce this update to a consumer? Required for breaking changes, appreciated for changes with a11y impact, and welcomed for non-breaking changes when relevant. + +[#PR no]: [PR link] ## Steps to test @@ -32,7 +52,7 @@ Addresses #*PR# HERE* - [ ] Contributor has fully tested the PR manually - [ ] If there are any front-end changes, before/after screenshots are included - [ ] Critical and brittle code paths are covered by unit tests -- [ ] The change has been added to the `changelog` +- [ ] The change is described clearly in the changelog section above ## Reviewer guidance @@ -42,5 +62,9 @@ Addresses #*PR# HERE* - [ ] Are all UI components LTR and RTL compliant (if applicable)? - [ ] _Add other things to check for here_ +## After review + +- [ ] The changelog item has been pasted to the `CHANGELOG.md` + ## Comments diff --git a/CHANGELOG.md b/CHANGELOG.md index 42e8ada00..06073babc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,7 +22,7 @@ Changelog Guidelines **************************** -- [PR no] +- [#PR no] - **Description:** Summary of change(s) - **Products impact:** Choose from - none (for internal updates) / bugfix / new API / updated API / removed API. If it's 'none', use "-" for all items below to indicate they are not relevant. - **Addresses:** Link(s) to GH issue(s) addressed. Include KDS links as well as links to related issues in a consumer product repository too. @@ -31,7 +31,7 @@ Changelog Guidelines - **Impacts a11y:** Does this change improve a11y or adds new features that can be used to improve it? Choose from: yes / no - **Guidance:** Why and how to introduce this update to a consumer? Required for breaking changes, appreciated for changes with a11y impact, and welcomed for non-breaking changes when relevant. -[PR no]: [PR ref] +[#PR no]: [PR link] ****************************