@@ -30,11 +30,10 @@ use github's pull request workflow to review the contribution, and either ask
3030you to make any refinements needed or merge it and make them ourselves. The
3131changes will then land on master when we next do a release.
3232
33- We use `CircleCI <https://circleci.com/gh/matrix-org >`_ and `Buildkite
34- <https://buildkite.com/matrix-dot-org/synapse> `_ for continuous integration.
35- Buildkite builds need to be authorised by a maintainer. If your change breaks
36- the build, this will be shown in GitHub, so please keep an eye on the pull
37- request for feedback.
33+ We use `Buildkite <https://buildkite.com/matrix-dot-org/synapse >`_ for
34+ continuous integration. Buildkite builds need to be authorised by a
35+ maintainer. If your change breaks the build, this will be shown in GitHub, so
36+ please keep an eye on the pull request for feedback.
3837
3938To run unit tests in a local development environment, you can use:
4039
@@ -70,13 +69,21 @@ All changes, even minor ones, need a corresponding changelog / newsfragment
7069entry. These are managed by Towncrier
7170(https://github.com/hawkowl/towncrier).
7271
73- To create a changelog entry, make a new file in the ``changelog.d ``
74- file named in the format of ``PRnumber.type ``. The type can be
75- one of ``feature ``, ``bugfix ``, ``removal `` (also used for
76- deprecations), or ``misc `` (for internal-only changes).
77-
78- The content of the file is your changelog entry, which can contain Markdown
79- formatting. The entry should end with a full stop ('.') for consistency.
72+ To create a changelog entry, make a new file in the ``changelog.d `` file named
73+ in the format of ``PRnumber.type ``. The type can be one of the following:
74+
75+ * ``feature ``.
76+ * ``bugfix ``.
77+ * ``docker `` (for updates to the Docker image).
78+ * ``doc `` (for updates to the documentation).
79+ * ``removal `` (also used for deprecations).
80+ * ``misc `` (for internal-only changes).
81+
82+ The content of the file is your changelog entry, which should be a short
83+ description of your change in the same style as the rest of our `changelog
84+ <https://github.com/matrix-org/synapse/blob/master/CHANGES.md> `_. The file can
85+ contain Markdown formatting, and should end with a full stop ('.') for
86+ consistency.
8087
8188Adding credits to the changelog is encouraged, we value your
8289contributions and would like to have you shouted out in the release notes!
0 commit comments