Skip to content

Commit 53d422d

Browse files
committed
fix: add requirements to update the changelog
1 parent 70bd0ef commit 53d422d

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

.github/CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,9 +74,10 @@ guidelines to help:
7474

7575
1. **Solve a problem** – Features are great, but even better is cleaning-up and fixing issues in the code that you discover.
7676
2. **Write tests** – This helps preserve functionality as the codebase grows and demonstrates how your change affects the code.
77-
3. **Write documentation** – We have a [README] that always needs updating.
78-
4. **Small > big** – Better to have a few small pull requests that address specific parts of the code, than one big pull request that jumps all over.
79-
5. **Comply with Coding Standards** – See next section.
77+
3. **Update the changelog** – All PRs should include a changelog entry. (see [Changelog Guidelines](#changelog-guidelines) below).
78+
4. **Write documentation** – We have a [README] that always needs updating.
79+
5. **Small > big** – Better to have a few small pull requests that address specific parts of the code, than one big pull request that jumps all over.
80+
6. **Comply with Coding Standards** – See next section.
8081

8182
### How to start
8283

@@ -107,6 +108,8 @@ When contributing to this project, it's important to document your changes in th
107108

108109
### When to Add Changelog Entries
109110

111+
**Every pull request should include a changelog entry**
112+
110113
Add a changelog entry for changes, including:
111114

112115
- **Added**: New features, components, or functionality

docs/making-releases.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ This command will update the version in the `package.json` and `package-lock.jso
4242

4343
## Update the Changelog
4444

45+
**Note**: Contributors should have already added their changes to the `[Unreleased]` section as part of their pull requests (see [CONTRIBUTING.md](../.github/CONTRIBUTING.md#changelog-guidelines) for details).
46+
4547
Before releasing, ensure the changelog is properly prepared:
4648

4749
1. **Review the [Unreleased] section** in `CHANGELOG.md` and `packages/design-system/CHANGELOG.md`

0 commit comments

Comments
 (0)