Skip to content

State the changelog fragment cap where a contributor will see it #259

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

Merged
skyoo2003 merged 1 commit into from
Sep 6, 2026
Merged

State the changelog fragment cap where a contributor will see it #259

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
5 changes: 5 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down