Skip to content
Snippets Groups Projects
Unverified Commit 82276a18 authored by Amber Brown's avatar Amber Brown Committed by GitHub
Browse files

Update CONTRIBUTING to clarify miscs & Markdown (#3730)

parent b1580f50
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
CONTRIBUTING.rst
+ 4
− 3
View file @ 82276a18
...@@ -59,9 +59,10 @@ To create a changelog entry, make a new file in the ``changelog.d`` ...@@ -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 file named in the format of ``PRnumber.type``. The type can be
one of ``feature``, ``bugfix``, ``removal`` (also used for one of ``feature``, ``bugfix``, ``removal`` (also used for
deprecations), or ``misc`` (for internal-only changes). The content of deprecations), or ``misc`` (for internal-only changes). The content of
the file is your changelog entry, which can contain RestructuredText the file is your changelog entry, which can contain Markdown
formatting. A note of contributors is welcomed in changelogs for formatting. Adding credits to the changelog is encouraged, we value
non-misc changes (the content of misc changes is not displayed). 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 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 ``changelog.d/1234.bugfix``, and contain content like "The security levels of
......
changelog.d/3730.misc 0 → 100644
+ 1
− 0
View file @ 82276a18
The CONTRIBUTING guidelines have been updated to mention our use of Markdown and that .misc files have content.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment