Skip to content

docs(agents): credit contributors and keep release notes short #53

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
hazeliscoding merged 2 commits into from
Oct 22, 2026
Merged

docs(agents): credit contributors and keep release notes short #53

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3efbb8
docs(agents): credit contributors in release notes
hazeliscoding Oct 22, 2026
0384fbe
docs(agents): keep release notes short and easy to scan
hazeliscoding Oct 22, 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
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,6 @@ Everything must run the same in PowerShell and bash: use `node` scripts, never b
- Conventional Commits, small and atomic. No AI attribution or co-author trailers.
- `main` is protected: every change reaches it through a pull request whose CI (`check` and `e2e`) passes, with no direct pushes, even by admins. Work on a branch named for the change (`data/add-conventions`, `docs/listing-rules`), one pull request per issue or per change. Merge with **Rebase and merge** so each commit lands on `main` as written.
- Tagging and publishing a release happen only at a milestone gate the maintainer approved. Versioning rules are in `ROADMAP.md` (2026-10-18), steps in `docs/MAINTENANCE.md`.
- Release notes credit contributors. When you rewrite GitHub's generated notes by hand, keep its credits: thank everyone outside the project by @-name with their pull requests, and say when it's their first contribution. v0.2.0 went out without crediting #34, #35 and #36 because its notes were rewritten without them.
- Release notes are short and easy to scan (the maintainer's preference): a bold one-line summary, a three-step "Try it", one-line bullets that start with a bold label, a "Heads-up" for this release's caveats, then "Thanks". Leave out what the README already says, such as what the site is and how to run it. v0.2.0's notes are the model.
- Do not push a branch, open or merge a pull request, create or change the GitHub repo, or deploy without the maintainer's explicit go-ahead. A "push" covers pushing the branch and opening its pull request; merging needs its own go-ahead.
Loading