File tree Expand file tree Collapse file tree 2 files changed +30
-0
lines changed
docs/changelog-fragments.d Expand file tree Collapse file tree 2 files changed +30
-0
lines changed Original file line number Diff line number Diff line change 1+ The changelog management is now implemented through
2+ the :std:doc: `Towncrier <towncrier:index >` tool
3+ -- by :user: `webknjaz `.
4+
5+ The contributors are now expected to :std:ref: `include
6+ change log fragment files in their pull requests
7+ <adding change notes with your prs>`.
8+
9+ These news snippets can link one or more issues or pull
10+ requests, and be of one or more of the following categories:
11+
12+ * ``bugfix ``: A bug fix for something we deemed an improper undesired
13+ behavior that got corrected in the release to match pre-agreed
14+ expectations.
15+ * ``feature ``: A new behavior, public APIs. That sort of stuff.
16+ * ``deprecation ``: A declaration of future API removals and breaking
17+ changes in behavior.
18+ * ``breaking ``: When something public gets removed in a breaking way.
19+ Could be deprecated in an earlier release.
20+ * ``doc ``: Notable updates to the documentation structure or build
21+ process.
22+ * ``packaging ``: Notes for downstreams about unobvious side effects
23+ and tooling. Changes in the test invocation considerations and
24+ runtime assumptions.
25+ * ``contrib ``: Stuff that affects the contributor experience. e.g.
26+ Running tests, building the docs, setting up the development
27+ environment.
28+ * ``misc ``: Changes that are hard to assign to any of the above
29+ categories.
Original file line number Diff line number Diff line change 1+ 654.contrib.rst
You can’t perform that action at this time.
0 commit comments