diff options
| author | Jason R. Coombs <jaraco@jaraco.com> | 2020-10-17 11:54:14 -0400 |
|---|---|---|
| committer | Jason R. Coombs <jaraco@jaraco.com> | 2020-10-17 11:54:14 -0400 |
| commit | b7c83dad9e11fbbc2a69fcc5fc26d4c7d1f5551f (patch) | |
| tree | 6e44ffdf5ee615d3a845106e3a51c172b2dedce0 /docs/developer-guide.rst | |
| parent | b66e45a90e82c9170cc48f21e4dac9d206193953 (diff) | |
| parent | 61e61296d9537c3e82516611ec283e42b1ed0466 (diff) | |
| download | python-setuptools-git-b7c83dad9e11fbbc2a69fcc5fc26d4c7d1f5551f.tar.gz | |
Merge branch 'master' into patch-1
Diffstat (limited to 'docs/developer-guide.rst')
| -rw-r--r-- | docs/developer-guide.rst | 35 |
1 files changed, 8 insertions, 27 deletions
diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index e84cd640..d2366931 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -61,33 +61,14 @@ 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://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 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: - -- ``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 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 -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 +When making a pull request, please +:ref:`include a short summary of the changes <Adding change notes +with your PRs>` 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. + +.. include:: ../changelog.d/README.rst ------------------- Auto-Merge Requests |