diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 33bbe7805..c45bbe6a0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,6 +11,27 @@ 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 +53,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 in the changelog section above ## Reviewer guidance @@ -42,5 +63,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..690a534bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,42 +1,3 @@ - - # Changelog Changelog is rather internal in nature. See release notes for the public overview and guidelines. Releases are recorded as git tags in the [Github releases](https://github.com/learningequality/kolibri-design-system/releases) page.