Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document news fragment type in contributing guide #522

Merged
merged 6 commits into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,18 @@ We recommend the following workflow:
c. Document any user-facing changes in one of the ``/docs/`` files.
Please use `one sentence per line`_.

d. Create a newsfragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users.
d. Create a news fragment in ``src/towncrier/newsfragments/`` describing the changes and containing information that is of interest to end-users.
Please use `one sentence per line`_ here, too.
hynek marked this conversation as resolved.
Show resolved Hide resolved
hynek marked this conversation as resolved.
Show resolved Hide resolved
You can use the ``towncrier`` CLI to create them; for example ``towncrier create 1234.bugfix``

Use one of the following types:

- ``feature`` for new features
- ``bugfix`` for bugfixes
- ``doc`` for improvements to documentation
- ``removal`` for deprecations and removals
- ``misc`` for everything else that is linked but not shown in our ``NEWS.rst`` file.
Use this for pull requests that don't affect end-users and leave them empty.

e. Create a `pull request`_.
Describe in the pull request what you did and why.
Expand Down
Empty file.