From 8489bcb05e871252705b73c77f169716d2d98be9 Mon Sep 17 00:00:00 2001 From: Ionut Filip Date: Thu, 14 Feb 2019 17:24:12 +0200 Subject: [PATCH] Minor changes to changelog doc --- docs/contributors/guide.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/contributors/guide.rst b/docs/contributors/guide.rst index 4b9820b7..0ae15c03 100644 --- a/docs/contributors/guide.rst +++ b/docs/contributors/guide.rst @@ -76,16 +76,16 @@ Adding entries in the CHANGELOG is an automated process which requires creation ``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 +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. +- ``.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 ---------------