diff options
| author | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2020-09-20 21:14:59 +0200 |
|---|---|---|
| committer | Sviatoslav Sydorenko <wk@sydorenko.org.ua> | 2020-09-24 22:58:20 +0200 |
| commit | 0d6920524ed2395e1cab7e7141c58423d94a424f (patch) | |
| tree | f43da25582131153178c14b377ae0dbeaf5140d0 /docs | |
| parent | 2754213b760fa4ba845bddda3ac4c0ec34c39e4b (diff) | |
| download | python-setuptools-git-0d6920524ed2395e1cab7e7141c58423d94a424f.tar.gz | |
📝 Add an illustrative explanation of change notes
This change places a `README.rst` document under `changelog.d/` dir in
order for GitHub to render it when users navigate to this location via
the web UI.
It also includes that into the dev guide in Sphinx docs.
Diffstat (limited to 'docs')
| -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 efbf1b7c..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:: shell-session - - $ 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 |