jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README for CHANGELOG about using multiple paragraphs

This commit is contained in:
Bruno Oliveira 2018-07-07 11:07:13 -03:00
parent 1cd62f8c38
commit 05f1d0d3ef
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
changelog/README.rst
View File

@ -26,7 +26,7 @@ changelog using that instead.
If you are not sure what issue type to use, don't hesitate to ask in your PR. If you are not sure what issue type to use, don't hesitate to ask in your PR.
Note that the ``towncrier`` tool will automatically ``towncrier`` preserves multiple paragraphs and formatting (code blocks, lists, and so on), but for entries
reflow your text, so it will work best if you stick to a single paragraph, but multiple sentences and links are OK other than ``features`` it is usually better to stick to a single paragraph to keep it concise. You can install
and encouraged. You can install ``towncrier`` and then run ``towncrier --draft`` ``towncrier`` and then run ``towncrier --draft``
if you want to get a preview of how your change will look in the final release notes. if you want to get a preview of how your change will look in the final release notes.