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.

Sign up for GitHub

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

Jump to bottom

Link to changelog guildelines from contributing docs #2415

Merged
merged 1 commit into from
Sep 17, 2021
Merged

Link to changelog guildelines from contributing docs #2415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion changelog/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
This directory contains "newsfragments" which are short files that contain a small
**ReST**-formatted text that will be added to ``CHANGES.rst``.
**ReST**-formatted text that will be added to ``CHANGES.rst`` by `towncrier
<https://towncrier.readthedocs.io/en/actual-freaking-docs/>`__.

The ``CHANGELOG`` will be read by **users**, so this description should be aimed to
urllib3 users instead of describing internal changes which are only relevant to the
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ If you wish to add a new feature or fix a bug:
as expected.
#. Format your changes with black using command `$ nox -rs format` and lint your
changes using command `nox -rs lint`.
#. Add a changelog entry using `towncrier
<https://towncrier.readthedocs.io/en/actual-freaking-docs/quickstart.html#creating-news-fragments>`__.
#. Add a `changelog entry
<https://github.com/urllib3/urllib3/blob/main/changelog/README.rst>`__.
#. Send a pull request and bug the maintainer until it gets merged and published.


Expand Down