From 43acf24cc8cebe30bd2d72d856668e1ec67c2c7a Mon Sep 17 00:00:00 2001 From: Andy Chosak Date: Mon, 27 Jan 2020 09:25:42 -0500 Subject: [PATCH] Always include contributor names in the CHANGELOG 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. --- docs/contributing/committing.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/contributing/committing.rst b/docs/contributing/committing.rst index 7c5cd5084..a9de9d3eb 100644 --- a/docs/contributing/committing.rst +++ b/docs/contributing/committing.rst @@ -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