Commit 1f2966e 1 parent 9eb3aad commit 1f2966e Copy full SHA for 1f2966e
File tree 1 file changed +5
-2
lines changed
1 file changed +5
-2
lines changed Original file line number Diff line number Diff line change @@ -112,7 +112,7 @@ this project adheres to [Semantic Versioning][ref-semantic-versioning].
112
112
Please add a changelog snippet for every PR you contribute. The changes are
113
113
categorised into:
114
114
115
- - ` Bugfixes ` fix an issue which can be used out of the box without any further
115
+ - ` bugfixes ` fix an issue which can be used out of the box without any further
116
116
changes required by the user. Be aware that in some cases bugfixes can be
117
117
breaking changes.
118
118
- ` features ` is used to indicate a backwards compatible change providing
@@ -146,9 +146,12 @@ Commit the changes and the snippet file and run the following command to create
146
146
a changelog with the latest snippet included
147
147
148
148
``` bash
149
- changelog-generator changelog changelog.md --snippets=.snippets
149
+ changelog-generator changelog changelog.md --snippets=.snippets --in-place
150
150
```
151
151
152
+ * Be aware to restore the changelog before another run as it might generate
153
+ version entries and version bumps multiple times otherwise.*
154
+
152
155
### Version file
153
156
154
157
The package version file, located at ` <PACKAGE_NAME>/version.py ` contains the
You can’t perform that action at this time.
0 commit comments