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
......@@ -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
......
The CONTRIBUTING guidelines have been updated to mention our use of Markdown and that .misc files have content.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment