Commit f4eb1393 authored by mergify[bot]'s avatar mergify[bot] Committed by GitHub

Merge pull request #1622 from pganssle/tweak_guide

Tweak "making a pull request" documentation
parents b82c731a 135a1566
...@@ -68,7 +68,7 @@ changelog entry. ...@@ -68,7 +68,7 @@ changelog entry.
``setuptools`` uses `towncrier <https://pypi.org/project/towncrier/>`_ ``setuptools`` uses `towncrier <https://pypi.org/project/towncrier/>`_
for changelog management, so when making a PR, please add a news fragment in the for changelog management, so when making a PR, please add a news fragment in the
``changelog.d/`` folder. Changelog files are written in Restructured Text and ``changelog.d/`` folder. Changelog files are written in reStructuredText and
should be a 1 or 2 sentence description of the substantive changes in the PR. should be a 1 or 2 sentence description of the substantive changes in the PR.
They should be named ``<pr_number>.<category>.rst``, where the categories are: They should be named ``<pr_number>.<category>.rst``, where the categories are:
...@@ -76,7 +76,7 @@ They should be named ``<pr_number>.<category>.rst``, where the categories are: ...@@ -76,7 +76,7 @@ They should be named ``<pr_number>.<category>.rst``, where the categories are:
- ``breaking``: Any backwards-compatibility breaking change - ``breaking``: Any backwards-compatibility breaking change
- ``doc``: A change to the documentation - ``doc``: A change to the documentation
- ``misc``: Changes internal to the repo like CI, test and build changes - ``misc``: Changes internal to the repo like CI, test and build changes
- ``deprecation``: For deprecations of an existing feature of behavior - ``deprecation``: For deprecations of an existing feature or behavior
A pull request may have more than one of these components, for example a code A pull request may have more than one of these components, for example a code
change may introduce a new feature that deprecates an old feature, in which change may introduce a new feature that deprecates an old feature, in which
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment