Merge pull request #1787 from matrix-org/dbkr/new_changelogs

Contributing guidelines for new changelog generation

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,7 @@
 <!-- Please read https://github.com/matrix-org/matrix-js-sdk/blob/develop/CONTRIBUTING.md before submitting your pull request -->
 
 <!-- Include a Sign-Off as described in https://github.com/matrix-org/matrix-js-sdk/blob/develop/CONTRIBUTING.md#sign-off -->
+
+<!-- To specify text for the changelog entry (otherwise the PR title will be used):
+Notes:
+-->

CONTRIBUTING.md

@@ -16,18 +16,77 @@ The preferred and easiest way to contribute changes to the project is to fork
 it on github, and then create a pull request to ask us to pull your changes
 into our repo (https://help.github.com/articles/using-pull-requests/)
 
-**The single biggest thing you need to know is: please base your changes on
+We use GitHub's pull request workflow to review the contribution, and either
-the develop branch - /not/ master.**
+ask you to make any refinements needed or merge it and make them ourselves.
 
-We use the master branch to track the most recent release, so that folks who
+Things that should go into your PR description:
-blindly clone the repo and automatically check out master get something that
+ * A changelog entry in the `Notes` section (see below)
-works. Develop is the unstable branch where all the development actually
+ * References to any bugs fixed by the change (in GitHub's `Fixes` notation)
-happens: the workflow is that contributors should fork the develop branch to
+ * Notes for the reviewer that might help them to understand why the change is
-make a 'feature' branch for a particular contribution, and then make a pull
+   necessary or how they might better review it.
-request to merge this back into the matrix.org 'official' develop branch. We
+
-use GitHub's pull request workflow to review the contribution, and either ask
+Things that should *not* go into your PR description:
-you to make any refinements needed or merge it and make them ourselves. The
+ * Any information on how the code works or why you chose to do it the way
-changes will then land on master when we next do a release.
+   you did. If this isn't obvious from your code, you haven't written enough
+   comments.
+
+We rely on information in pull request to populate the information that goes
+into the changelogs our users see, both for the JS SDK itself and also for some
+projects based on it. This is picked up from both labels on the pull request and
+the `Notes:` annotation in the description. By default, the PR title will be
+used for the changelog entry, but you can specify more options, as follows.
+
+To add a longer, more detailed description of the change for the changelog:
+
+
+*Fix llama herding bug*
+
+```
+Notes: Fix a bug (https://github.com/matrix-org/notaproject/issues/123) where the 'Herd' button would not herd more than 8 Llamas if the moon was in the waxing gibbous phase
+```
+
+For some PRs, it's not useful to have an entry in the user-facing changelog (this is
+the default for PRs labelled with `T-Task`):
+
+*Remove outdated comment from `Ungulates.ts`*
+```
+Notes: none
+```
+
+Sometimes, you're fixing a bug in a downstream project, in which case you want
+an entry in that project's changelog. You can do that too:
+
+*Fix another herding bug*
+```
+Notes: Fix a bug where the `herd()` function would only work on Tuesdays
+element-web notes: Fix a bug where the 'Herd' button only worked on Tuesdays
+```
+
+This example is for Element Web. You can specify:
+ * matrix-react-sdk
+ * element-web
+ * element-desktop
+
+If your PR introduces a breaking change, use the `Notes` section in the same
+way, additionally adding the `X-Breaking-Change` label (see below). There's no need
+to specify in the notes that it's a breaking change - this will be added
+automatically based on the label - but remember to tell the developer how to
+migrate:
+
+*Remove legacy class*
+
+```
+Notes: Remove legacy `Camelopard` class. `Giraffe` should be used instead.
+```
+
+Other metadata can be added using labels.
+ * `X-Breaking-Change`: A breaking change - adding this label will mean the change causes a *major* version bump.
+ * `T-Enhancement`: A new feature - adding this label will mean the change causes a *minor* version bump.
+ * `T-Defect`: A bug fix (in either code or docs).
+ * `T-Task`: No user-facing changes, eg. code comments, CI fixes, refactors or tests. Won't have a changelog entry unless you specify one.
+
+If you don't have permission to add labels, your PR reviewer(s) can work with you
+to add them: ask in the PR description or comments.
 
 We use continuous integration, and all pull requests get automatically tested:
 if your change breaks the build, then the PR will show that there are failed