From e674a6fe3d7ed08d6ee830a9eeea8be5ec43a31a Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Thu, 14 Feb 2019 17:18:10 +0200 Subject: [PATCH] Added docs for new changelog entries --- docs/contributors/guide.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/contributors/guide.rst b/docs/contributors/guide.rst index a3b6d95a..4b9820b7 100644 --- a/docs/contributors/guide.rst +++ b/docs/contributors/guide.rst @@ -69,6 +69,24 @@ After some testing on master, we will approve and merge this new PR as well. At the end of every milestone, a new stable branch will be created from ``master`` or any previous commit that matches the completion of the milestone. +CHANGELOG +````````` + +Adding entries in the CHANGELOG is an automated process which requires creation of a file under +``towncrier/newsfragments`` directory. + +The start of the filename is the ticket number, and the content is what will end up in the news file. +For example, if ticket #850 is about adding a new widget, the filename would be towncrier/newsfragments/850.feature +and the content would be ``Feature that has just been added``. + +Supported file extensions are: + +- .feature: Signifying a new feature. +- .bugfix: Signifying a bug fix. +- .doc: Signifying a documentation improvement. +- .removal: Signifying a deprecation or removal of public API. +- .misc: A ticket has been closed, but it is not of interest to users. + Forked projects ---------------