Add changelog section to PR template

MisRob · Oct 13, 2023 · 335b29b · 335b29b
1 parent e578ede
commit 335b29b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -11,6 +11,25 @@ Addresses #*PR# HERE*
 ### Before/after screenshots
 <!-- Insert images here if applicable -->
 
+## Changelog
+
+<!--
+  Fill in the changelog item below.
+  This will be pasted to CHANGELOG.md before merging a PR.
+  See CHANGELOG.md for examples and changelog guidelines.
+  Required for the core team members. Optional for contributors.
+ -->
+
+- [#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
 

diff --git 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]
 
 ****************************