mirror of
https://github.com/containers/podman-compose.git
synced 2024-11-29 03:15:06 +01:00
Merge pull request #974 from p12tic/newsfragments
Use newsfragments pattern for the release notes
This commit is contained in:
commit
0cd3902c5f
3
.github/PULL_REQUEST_TEMPLATE.md
vendored
3
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -4,4 +4,7 @@
|
|||||||
If this PR adds a new feature that improves compatibility with docker-compose, please add a link
|
If this PR adds a new feature that improves compatibility with docker-compose, please add a link
|
||||||
to the exact part of compose spec that the PR touches.
|
to the exact part of compose spec that the PR touches.
|
||||||
|
|
||||||
|
For any user-visible change please add a release note to newsfragments directory, e.g.
|
||||||
|
newsfragments/my_feature.feature. See newsfragments/README.md for more details.
|
||||||
|
|
||||||
All changes require additional unit tests.
|
All changes require additional unit tests.
|
||||||
|
13
newsfragments/README.txt
Normal file
13
newsfragments/README.txt
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
This is the directory for news fragments used by towncrier: https://github.com/hawkowl/towncrier
|
||||||
|
|
||||||
|
You create a news fragment in this directory when you make a change, and the file gets removed from
|
||||||
|
this directory when the news is published.
|
||||||
|
|
||||||
|
towncrier has a few standard types of news fragments, signified by the file extension. These are:
|
||||||
|
|
||||||
|
.feature: Signifying a new feature.
|
||||||
|
.bugfix: Signifying a bug fix.
|
||||||
|
.doc: Signifying a documentation improvement.
|
||||||
|
.removal: Signifying a deprecation or removal of public API.
|
||||||
|
.change: Signifying a change of behavior
|
||||||
|
.misc: Miscellaneous change
|
Loading…
Reference in New Issue
Block a user