Skip to content

Commit 686a126

Browse files
committed
updated readme
Signed-off-by: Vedansh Saini <[email protected]>
1 parent 2fcf054 commit 686a126

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,25 @@ For more details, see the [Chrome i18n documentation](https://developer.chrome.c
182182

183183
- Follow the Issues and PRs templates as far as possible.
184184
- If you want to make a PR, please mention in the corresponding issue that you are working on it.
185+
186+
### Writing Meaningful Pull Requests
187+
188+
The release notes are automatically generated from the pull requests merged into `master`. To ensure the release notes are clear and helpful, please:
189+
190+
1. **Write a descriptive title.** The PR title is the primary entry in the release notes. It should concisely summarize the change.
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+
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**.
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:
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.
201+
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.
203+
185204
- Before making a PR, ensure your code is properly formatted and linted:
186205
- Format your code: This command automatically formats your code based on the project's style guidelines.
187206
```sh

0 commit comments

Comments
 (0)