diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 187c555..47d945e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,6 +15,11 @@ Brief description of the changes. - ... +## Changelog + +- [ ] `changie new` fragment added — one sentence, two at most, 280 characters max +- [ ] Not user-visible, no fragment needed + ## Testing - [ ] `make all` passes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 56ff686..bb8d103 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,8 +67,10 @@ make setup # installs pre-commit hooks - Keep PRs small and focused on a single concern - Include tests for new functionality -- Add a changelog fragment for user-visible changes: `changie new`, one sentence, two at most (see - [Release Process](https://skyoo2003.github.io/kvs/docs/release/)) +- Add a changelog fragment for user-visible changes: `changie new`, one sentence, two at most. + `.changie.yaml` caps a body at 280 characters, which is about where a second sentence ends; a + fragment that needs more is carrying documentation, which belongs on a page the notes can link to + (see [Release Process](https://skyoo2003.github.io/kvs/docs/release/)) - Ensure `make all` passes (lint + test + build) - Update documentation if behavior changes