From 11153168a214a3ced95f53c1753bc918214762e8 Mon Sep 17 00:00:00 2001 From: Amber Brown Date: Tue, 21 Aug 2018 23:28:12 +1000 Subject: [PATCH 1/2] Update CONTRIBUTING to clarify miscs & Markdown --- CONTRIBUTING.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3d75853aa7e2..f9de78a4602f 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 From 2be6c9ddb57e8fcd888a026e469622e735b019b3 Mon Sep 17 00:00:00 2001 From: Amber Brown Date: Tue, 21 Aug 2018 23:29:31 +1000 Subject: [PATCH 2/2] changelog --- changelog.d/3730.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/3730.misc diff --git a/changelog.d/3730.misc b/changelog.d/3730.misc new file mode 100644 index 000000000000..b1ea84f732a2 --- /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.