It is very important to maintain a log for news of how updating to the new version of the software will affect end-users. This is why we enforce collection of the change fragment files in pull requests as per Alright! So how to add a news fragment?
setuptools uses :pypi:`towncrier` for changelog management.
To submit a change note about your PR, add a text file into the
changelog.d/ folder. It should contain an
explanation of what applying this PR will change in the way
end-users interact with the project. One sentence is usually
enough but feel free to add as many details as you feel necessary
for the users to understand what it means.
Use the past tense for the text in your fragment because,
combined with others, it will be a part of the "news digest"
telling the readers what changed in a specific version of
the library since the previous version. You should also use
reStructuredText syntax for highlighting code (inline or block),
linking parts of the docs or external sites.
If you wish to sign your change, feel free to add -- by
:user:`github-username` at the end (replace github-username
with your own!).
Finally, name your file following the convention that Towncrier
understands: it should start with the number of an issue or a
PR followed by a dot, then add a patch type, like change,
doc, misc etc., and add .rst as a suffix. If you
need to add more than one fragment, you may add an optional
sequence number (delimited with another period) between the type
and the suffix.
In general the name will follow <pr_number>.<category>.rst pattern,
where the categories are:
change: Any backwards compatible code changebreaking: Any backwards-compatibility breaking changedoc: A change to the documentationmisc: Changes internal to the repo like CI, test and build changesdeprecation: For deprecations of an existing feature or behaviorA 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.
File :file:`changelog.d/2395.doc.1.rst`:
Added a ``:user:`` role to Sphinx config -- by :user:`webknjaz`
File :file:`changelog.d/1354.misc.rst`:
Added ``towncrier`` for changelog management -- by :user:`pganssle`
File :file:`changelog.d/2355.change.rst`:
When pip is imported as part of a build, leave :py:mod:`distutils`
patched -- by :user:`jaraco`
Tip
See :file:`pyproject.toml` for all available categories
(tool.towncrier.type).
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。