You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,14 +20,23 @@ First of all thank you very much for your interest in contributing to this proje
20
20
21
21
## Maintaining the Changelog
22
22
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
24
37
25
38
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)
31
40
3.**Write clear, concise descriptions** that help users understand the impact of changes
32
41
4.**Include relevant issue numbers** when applicable
0 commit comments