Browse Source

Update CONTRIBUTING to clarify miscs & Markdown (#3730)

Amber Brown 5 years ago
parent
commit
82276a18d1
2 changed files with 5 additions and 3 deletions
  1. 4 3
      CONTRIBUTING.rst
  2. 1 0
      changelog.d/3730.misc

+ 4 - 3
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

+ 1 - 0
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.