Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Update CONTRIBUTING to clarify miscs & Markdown #3730

Merged
merged 2 commits into from
Aug 29, 2018
Merged

Update CONTRIBUTING to clarify miscs & Markdown #3730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1115316
Update CONTRIBUTING to clarify miscs & Markdown
hawkowl Aug 21, 2018
2be6c9d
changelog
hawkowl Aug 21, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions changelog.d/3730.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The CONTRIBUTING guidelines have been updated to mention our use of Markdown and that .misc files have content.