Skip to content

Commit 1f2966e

Browse files
add --in-place option in contribution guide line
1 parent 9eb3aad commit 1f2966e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/CONTRIBUTING.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ this project adheres to [Semantic Versioning][ref-semantic-versioning].
112112
Please add a changelog snippet for every PR you contribute. The changes are
113113
categorised into:
114114

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
116116
changes required by the user. Be aware that in some cases bugfixes can be
117117
breaking changes.
118118
- `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
146146
a changelog with the latest snippet included
147147

148148
```bash
149-
changelog-generator changelog changelog.md --snippets=.snippets
149+
changelog-generator changelog changelog.md --snippets=.snippets --in-place
150150
```
151151

152+
*Be aware to restore the changelog before another run as it might generate
153+
version entries and version bumps multiple times otherwise.*
154+
152155
### Version file
153156

154157
The package version file, located at `<PACKAGE_NAME>/version.py` contains the

0 commit comments

Comments
 (0)