diff options
| author | mergify[bot] <mergify[bot]@users.noreply.github.com> | 2019-01-01 18:28:01 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-01 18:28:01 +0000 |
| commit | f4eb1393730fea7e522b5622c1e2efaea9fd2cc3 (patch) | |
| tree | 80bc94462510dd54d860f6538b660f52093c19d9 | |
| parent | b82c731a66415225f111872cc26e7da596189a87 (diff) | |
| parent | 135a1566832cb75d37a9fbe1fe01005c0e05b4c3 (diff) | |
| download | external_python_setuptools-f4eb1393730fea7e522b5622c1e2efaea9fd2cc3.tar.gz external_python_setuptools-f4eb1393730fea7e522b5622c1e2efaea9fd2cc3.tar.bz2 external_python_setuptools-f4eb1393730fea7e522b5622c1e2efaea9fd2cc3.zip | |
Merge pull request #1622 from pganssle/tweak_guide
Tweak "making a pull request" documentation
| -rw-r--r-- | docs/developer-guide.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt index f82df397..a5942c8b 100644 --- a/docs/developer-guide.txt +++ b/docs/developer-guide.txt @@ -68,7 +68,7 @@ changelog entry. ``setuptools`` uses `towncrier <https://pypi.org/project/towncrier/>`_ 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. 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 - ``doc``: A change to the documentation - ``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 change may introduce a new feature that deprecates an old feature, in which |