Hopiu/wagtail
1
0
Fork 0
mirror of https://github.com/Hopiu/wagtail.git synced 2026-03-16 22:10:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Always include contributor names in the CHANGELOG

Browse source 
The CHANGELOG docs say that contributor names should only be included if
they are not a core committer, but historical practice has been to
always include names. Per discussion on the core team, we want to change
this guidance to explicitly recommend always including contributor
names.

This not only encourages and recognizes contributions but also helps
future contributors know who worked on different parts of the code. This
record (along with git history) provides a good reference to understand
who made certain changes or features.
This commit is contained in:
Andy Chosak 2020-01-27 09:25:42 -05:00
parent 81d23fc8ab
commit 43acf24cc8
1 changed files with 1 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/contributing/committing.rst
View file

@ -77,8 +77,7 @@ The ``CHANGELOG.txt`` contains a short summary of each new feature, refactoring,
Each summary should be a single line.
Bug fixes should be grouped together at the end of the list for each release,
and be prefixed with "Fix:".
The name of the contributor should be added at the end of the summary,
in brackets, if they are not a core committer.
The name of the contributor should be added at the end of the summary, in brackets.
For example:
.. code-block:: text