Browse Source

docs: update CONTRIBUTING.md with .changes instructions (#11013)

Felix Salazar 10 months ago
parent
commit
e266f2f35e
1 changed files with 3 additions and 0 deletions
  1. 3 0
      .github/CONTRIBUTING.md

+ 3 - 0
.github/CONTRIBUTING.md

@@ -37,9 +37,12 @@ Hi! We, the maintainers, are really excited that you are interested in contribut
   - Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
 
 - If fixing a bug:
+
   - If you are resolving a special issue, add `(fix: #xxxx[,#xxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `fix: update entities encoding/decoding (fix #3899)`.
   - Provide detailed description of the bug in the PR, or link to an issue that does.
 
+- If the PR is meant to be released, follow the instructions in `.changes/readme.md` to log your changes. ie. [readme.md](https://github.com/tauri-apps/tauri/blob/dev/.changes/README.md)
+
 ## Development Guide
 
 **NOTE: If you have any question don't hesitate to ask in our Discord server. We try to keep this guide to up guide, but if something doesn't work let us know.**