Skip to content

docs: require a changelog fragment per change #122

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
Unisay merged 2 commits into from
Jun 25, 2026
Merged

docs: require a changelog fragment per change #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51da975
docs: require a changelog fragment per change
Unisay Jun 25, 2026
2029174
docs: note the dev shell in the PR checklist
Unisay Jun 25, 2026
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
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!-- Describe the change and link the issue it closes, if any. -->

## Summary

## Checklist

- [ ] Added a `changelog.d/` fragment for any user-facing change (`scriv create`
in the dev shell), or this change ships nothing releasable (CI, docs, or an
internal refactor).
- [ ] In the dev shell (`nix develop`), `fourmolu -i lib/ exe/ test/` and
`hlint lib/ exe/ test/` are clean.
- [ ] In the dev shell, `cabal test all` passes; structural goldens were
re-accepted on purpose if codegen moved (`PSLUA_GOLDEN_ACCEPT=1`), and
`eval/golden.txt` still holds.
14 changes: 14 additions & 0 deletions docs/VERSIONING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,18 @@ the tags that actually exist.
5. Tag `main` with `<A.B.C.D>` (annotated) and create the GitHub release, using
the new changelog section as the release notes.

## Changelog fragments

Every user-facing change adds a fragment under `changelog.d/`: run `scriv create`
in the dev shell (which provides `scriv`), pick the right category
(Added/Changed/Fixed/Removed), and commit the fragment alongside the change. The
pull request template carries this as a checklist item. A change that ships
nothing releasable (CI, docs, an internal refactor) needs no fragment. On
release, `scriv collect` (step 3 above) folds the pending fragments into a new
`CHANGELOG.md` section.

This mirrors the rest of the ecosystem: the set forks and the package set keep
scriv changelogs too, with the shared reasoning recorded in the package set's
[ADR 0009](https://github.com/purescript-lua/purescript-lua-package-sets/blob/master/docs/adr/0009-changelogs-via-scriv.md).

[pvp]: https://pvp.haskell.org/
Loading