diff options
| author | Paul Ganssle <pganssle@users.noreply.github.com> | 2018-05-14 15:08:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-14 15:08:14 -0400 |
| commit | c70cc12b459ceaac1cc9df65b9e3a8582c5c49e4 (patch) | |
| tree | 3513ae757f5a16ffcd2af6d66bd563da96d362f9 /docs | |
| parent | 849d0616c3755588a60998ac286f8ff045eb1a95 (diff) | |
| parent | 51e3fabf063399ef5cf3bad9ef3b506108b5bb70 (diff) | |
| download | python-setuptools-git-c70cc12b459ceaac1cc9df65b9e3a8582c5c49e4.tar.gz | |
Merge pull request #1354 from pganssle/towncrier
Add configuration for towncrier
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/developer-guide.txt | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/developer-guide.txt b/docs/developer-guide.txt index 25aaeaab..ea1034ab 100644 --- a/docs/developer-guide.txt +++ b/docs/developer-guide.txt @@ -57,6 +57,38 @@ Setuptools makes extensive use of hyperlinks to tickets in the changelog so that system integrators and other users can get a quick summary, but then jump to the in-depth discussion about any subject referenced. +--------------------- +Making a pull request +--------------------- + +When making a pull request, please include a short summary of the changes +and a reference to any issue tickets that the PR is intended to solve. All +PRs with code changes should include tests. All changes should include a +changelog entry. + +``setuptools`` uses `towncrier <https://town-crier.readthedocs.io/en/latest/>`_ +for changelog managment, so when making a PR, please add a news fragment in the +``changelog.d/`` folder. Changelog files are written in Restructured Text 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: + +- ``change``: Any backwards compatible code change +- ``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 + +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 +case two fragments should be added. It is not necessary to make a separate +documentation fragment for documentation changes accompanying the relevant +code changes. See the following for an example news fragment: + +.. code-block:: bash + + $ cat changelog.d/1288.change.rst + Add support for maintainer in PKG-INFO + ----------- Source Code ----------- |