Skip to content

Add a note to README.md about CHANGELOG.md #3824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a note to README.md about CHANGELOG.md #3824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

### Fixes

- **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.

## 0.16.11

### Enhancements
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,10 @@ If using the optional `pre-commit`, you'll just need to install the hooks with `
`pre-commit` package is installed as part of `make install` mentioned above. Finally, if you decided to use `pre-commit`
you can also uninstall the hooks with `pre-commit uninstall`.

When submitting a pull request, make sure to add an entry to
[`CHANGELOG.md`](./CHANGELOG.md) (under the development version at the
top of the file) describing the changes.

In addition to develop in your local OS we also provide a helper to use docker providing a development environment:

```bash
Expand Down