Commit Graph

5 Commits

Author SHA1 Message Date
Bruno Oliveira 05f1d0d3ef Update README for CHANGELOG about using multiple paragraphs 2018-07-07 11:07:13 -03:00
Ronny Pfannschmidt 86fc31db8d apply most other hooks and opt out of black reformating 2018-05-23 16:45:58 +02:00
Bruno Oliveira 0f6879bf5e
Small update to changelog/README.rst 2018-02-17 10:20:41 -02:00
Bruno Oliveira eea169e515 Code review suggestions 2018-02-08 08:03:14 -02:00
Bruno Oliveira 40d0ade2d9 Add changelog/README.rst and streamline our PR template text
This streamlines the PR template text and adds a more in-depth explanation
about how the changelog entries work because this topic is a common source of
confusion:

- How to name the files.
- Which formatting to use (people in general assume it is Markdown).
- Recommend adding `.rst` extension to changelog files to help with the
  above (`towncrier` doesn't care).

This was heavily inspired by the excellent python-trio/trio docs.
2018-02-06 22:20:39 -02:00