Skip to content

Commit 2be422e

Browse files
hynekadiroiban
andauthored
Document news fragment type in contributing guide (#522)
* Document our news fragment types in CONTRIBUTING.rst * Add news fragment * spell out * Update CONTRIBUTING.rst Co-authored-by: Adi Roiban <adi.roiban@chevah.com> * Remove other please, too --------- Co-authored-by: Adi Roiban <adi.roiban@chevah.com>
1 parent 49a6cba commit 2be422e

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,20 @@ We recommend the following workflow:
6666
*Running the test suite* for details.
6767

6868
c. Document any user-facing changes in one of the ``/docs/`` files.
69-
Please use `one sentence per line`_.
69+
Use `one sentence per line`_.
7070

71-
d. Create a newsfragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users.
72-
Please use `one sentence per line`_ here, too.
71+
d. Create a news fragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users.
72+
Use `one sentence per line`_ here, too.
73+
You can use the ``towncrier`` CLI to create them; for example ``towncrier create 1234.bugfix``
74+
75+
Use one of the following types:
76+
77+
- ``feature`` for new features
78+
- ``bugfix`` for bugfixes
79+
- ``doc`` for improvements to documentation
80+
- ``removal`` for deprecations and removals
81+
- ``misc`` for everything else that is linked but not shown in our ``NEWS.rst`` file.
82+
Use this for pull requests that don't affect end-users and leave them empty.
7383

7484
e. Create a `pull request`_.
7585
Describe in the pull request what you did and why.

src/towncrier/newsfragments/522.misc

Whitespace-only changes.

0 commit comments

Comments
 (0)