Skip to content

Commit

Permalink
Add changelog section to PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
MisRob committed Oct 13, 2023
1 parent e578ede commit aed8662
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
25 changes: 24 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -32,7 +51,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
<!-- Delete anything that doesn't apply so your reviewer knows what to check for -->
Expand All @@ -42,5 +61,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
<!-- Any additional notes you'd like to add -->
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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]
****************************
Expand Down

0 comments on commit aed8662

Please sign in to comment.