Skip to content

Commit ad5edc6

Browse files
committed
docs: add note about changelog
1 parent 3b718ec commit ad5edc6

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
### Fixes
1010

11+
- **Remind contributors to update the changelog**. CI fails if you don't add an entry to `CHANGELOG.md` but this is not mentioned in the development documentation.
12+
1113
## 0.16.11
1214

1315
### Enhancements

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ If using the optional `pre-commit`, you'll just need to install the hooks with `
166166
`pre-commit` package is installed as part of `make install` mentioned above. Finally, if you decided to use `pre-commit`
167167
you can also uninstall the hooks with `pre-commit uninstall`.
168168

169+
When submitting a pull request, make sure to add an entry to
170+
[`CHANGELOG.md`](./CHANGELOG.md) (under the development version at the
171+
top of the file) describing the changes.
172+
169173
In addition to develop in your local OS we also provide a helper to use docker providing a development environment:
170174

171175
```bash

0 commit comments

Comments
 (0)