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: README.md
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -191,15 +191,26 @@ The release notes are automatically generated from the pull requests merged into
191
191
2.**Provide a clear description.** The body of your PR should explain the "what" and "why" of your changes. This context is invaluable for reviewers and for anyone looking back at the project's history.
192
192
193
193
### Pull Request Labeling & Semantic Versioning
194
-
This project uses an automated release process based on semantic versioning. To make this work, every pull request that should be included in the release notes**must be labeled correctly**.
194
+
This project uses an automated release process that relies on pull request labels and titles to determine the semantic version for a new release. For your contribution to be included in the release notes, please use one of the methods below.
195
195
196
-
The label determines whether the next release is a `major`, `minor`, or `patch` update. Please apply one of the following labels to your PR:
196
+
**Method 1: Using Labels (Preferred)**
197
197
198
-
-`major`: For breaking changes that are not backward-compatible. This will result in a `vX.0.0` release.
199
-
-`minor`: For new features or significant enhancements that are backward-compatible. This will result in a `v1.X.0` release.
200
-
-`patch`: For backward-compatible bug fixes, documentation updates, or maintenance chores. This will result in a `v1.2.X` release.
198
+
The clearest way to signal the impact of your change is to apply **one** of the following labels to your pull request. This is the recommended approach.
201
199
202
-
If a PR has no versioning label, it may be excluded from the release notes. If you are unsure, `patch` is usually a safe default for small fixes.
200
+
-`release:major`: For breaking changes that are not backward-compatible.
201
+
-`release:minor`: For new features or significant enhancements.
202
+
-`release:patch`: For backward-compatible bug fixes, documentation updates, or maintenance.
203
+
-`release:none`: To exclude the change from the release notes entirely.
204
+
205
+
**Method 2: Using PR Titles**
206
+
207
+
As a fallback, if no `release:*` label is applied, the system will inspect your pull request title for the following keywords (case-insensitive) to determine the version bump:
208
+
209
+
-`major`: For breaking changes.
210
+
-`minor`: For new features.
211
+
-`patch`, `fix`, `chore`, `documentation` : For bug fixes and other small changes.
212
+
213
+
If you are unsure which label to use, please write a clear and descriptive title, and a maintainer will apply the correct label before merging.
203
214
204
215
- Before making a PR, ensure your code is properly formatted and linted:
205
216
- Format your code: This command automatically formats your code based on the project's style guidelines.
0 commit comments