diff options
| author | Amber Brown <hawkowl@atleastfornow.net> | 2018-08-29 19:06:59 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-08-29 19:06:59 +1000 |
| commit | 82276a18d10e8b66a509344a94cc328584cee46f (patch) | |
| tree | baf79f0427929e9a2517613bcb67f614edf38157 | |
| parent | don't return non-LL-member state in incremental sync state blocks (#3760) (diff) | |
| download | synapse-82276a18d10e8b66a509344a94cc328584cee46f.tar.xz | |
Update CONTRIBUTING to clarify miscs & Markdown (#3730)
| -rw-r--r-- | CONTRIBUTING.rst | 7 | ||||
| -rw-r--r-- | changelog.d/3730.misc | 1 |
2 files changed, 5 insertions, 3 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3d75853aa7..f9de78a460 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -59,9 +59,10 @@ To create a changelog entry, make a new file in the ``changelog.d`` file named in the format of ``PRnumber.type``. The type can be one of ``feature``, ``bugfix``, ``removal`` (also used for deprecations), or ``misc`` (for internal-only changes). The content of -the file is your changelog entry, which can contain RestructuredText -formatting. A note of contributors is welcomed in changelogs for -non-misc changes (the content of misc changes is not displayed). +the file is your changelog entry, which can contain Markdown +formatting. Adding credits to the changelog is encouraged, we value +your contributions and would like to have you shouted out in the +release notes! For example, a fix in PR #1234 would have its changelog entry in ``changelog.d/1234.bugfix``, and contain content like "The security levels of diff --git a/changelog.d/3730.misc b/changelog.d/3730.misc new file mode 100644 index 0000000000..b1ea84f732 --- /dev/null +++ b/changelog.d/3730.misc @@ -0,0 +1 @@ +The CONTRIBUTING guidelines have been updated to mention our use of Markdown and that .misc files have content. |