Skip to content

Commit 20dc116

Browse files
committed
feat: update PR template
1 parent 569b1da commit 20dc116

File tree

2 files changed

+16
-7
lines changed

2 files changed

+16
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@
1212

1313
## Suggestions on how to test this:
1414

15-
## Is there a release notes update needed for this change?:
15+
## Is there a release notes or changelog update needed for this change?:
1616

1717
## Additional documentation:

CONTRIBUTING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,23 @@ First of all thank you very much for your interest in contributing to this proje
2020

2121
## Maintaining the Changelog
2222

23-
We follow the [Keep a Changelog](https://keepachangelog.com/) format for our changelog. When contributing:
23+
When contributing to this project, it's important to document your changes in the changelog to help users and developers understand what has been added, changed, fixed, or removed between versions. The changelog helps maintain transparency about project evolution and assists users in understanding the impact of updates. We also have another changelog for design system, so for any design system changes, please include them in that changelog.
24+
25+
### When to Add Changelog Entries
26+
27+
**Every pull request should include a changelog entry**
28+
29+
Add a changelog entry for changes, including:
30+
31+
- **Added**: New features, components, or functionality
32+
- **Changed**: Changes to existing functionality, API modifications, or package updates
33+
- **Fixed**: Bug fixes and issue resolutions
34+
- **Removed**: Deprecated features or removed functionality
35+
36+
### How to Add Changelog Entries
2437

2538
1. **Add your changes to the `[Unreleased]` section** at the top of `CHANGELOG.md`
26-
2. **Categorize your changes** under the appropriate headings:
27-
- **Added** for new features
28-
- **Changed** for changes in existing functionality
29-
- **Removed** for now removed features
30-
- **Fixed** for any bug fixes
39+
2. **Categorize your changes** under the appropriate category(Added, Changed, Fixed, Removed)
3140
3. **Write clear, concise descriptions** that help users understand the impact of changes
3241
4. **Include relevant issue numbers** when applicable
3342

0 commit comments

Comments
 (0)