aboutsummaryrefslogtreecommitdiff
path: root/AGENTS.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-05-15 21:22:56 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-05-15 21:24:05 +0300
commit16e10aa921711f1343d2af77978b71cbb4e7c461 (patch)
treedc166d8440529947a6877ee7ffde804892f66c63 /AGENTS.md
parente1a84a8e340f09b9479ca2df333ba135a45d2048 (diff)
docs: move changelog into next-release docs flow
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/AGENTS.md b/AGENTS.md
index b73c77cf..3f025ac2 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -51,10 +51,10 @@ Unit tests live next to the code (`#[cfg(test)] mod tests`). If you add behavior
## Conventions
- Conventional commits, lowercase, no emojis.
-- Do not edit `CHANGELOG.md` during normal feature or fix work. Changelog entries are drafted and applied immediately before release.
-- Treat the root public docs as the latest released docs. Do not document unreleased behavior in root `README.md`, `CONFIGURATION.md`, `INTEGRATIONS.md`, or `SOCKET_API.md` during normal feature or fix work.
-- Treat `.pi/docs/README.md`, `.pi/docs/CONFIGURATION.md`, `.pi/docs/INTEGRATIONS.md`, and `.pi/docs/SOCKET_API.md` as the next-release versions of those public docs. When unreleased work needs public documentation, update the matching file under `.pi/docs/` instead of the root file.
-- Before release, copy the approved `.pi/docs/` versions into the root public docs. `just release` blocks until each root public doc is identical to its `.pi/docs/` counterpart.
+- Do not edit root `CHANGELOG.md` during normal feature or fix work. For user-facing features, fixes, removals, breaking changes, and meaningful behavior changes, update `.pi/docs/CHANGELOG.md` in the same change when it makes sense.
+- Treat the root public docs as the latest released docs. Do not document unreleased behavior in root `README.md`, `CONFIGURATION.md`, `INTEGRATIONS.md`, `SOCKET_API.md`, or `CHANGELOG.md` during normal feature or fix work.
+- Treat `.pi/docs/README.md`, `.pi/docs/CONFIGURATION.md`, `.pi/docs/INTEGRATIONS.md`, `.pi/docs/SOCKET_API.md`, and `.pi/docs/CHANGELOG.md` as the next-release versions of those public docs. When unreleased work needs public documentation, update the matching file under `.pi/docs/` instead of the root file.
+- Before release, copy the approved `.pi/docs/` versions into the root public docs. `just release` blocks until each root public doc and `CHANGELOG.md` are identical to their `.pi/docs/` counterparts.
- Keep website copy and config examples aligned with the latest published release unless the user explicitly asks for prerelease docs.
- Put local PRDs, planning notes, and exploratory specs under `.prd/`; that directory is ignored and locally controlled.
- When a commit fully fixes a GitHub issue, include `fixes #<issue-number>` in the commit body so GitHub closes it on merge.
@@ -64,7 +64,7 @@ Unit tests live next to the code (`#[cfg(test)] mod tests`). If you add behavior
## Releases
-Before cutting a release, draft the upcoming notes under `## Unreleased` in `CHANGELOG.md`, review `.pi/docs/` against the root public docs, and copy the approved next-release docs into the root public docs. The release script promotes the changelog section into the versioned entry.
+Before cutting a release, run `/pre-release-audit` to compare commits since the last tag against `.pi/docs/CHANGELOG.md` and `.pi/docs/`, then copy the approved next-release docs and changelog into the root public docs. The release script promotes the root changelog's `## Unreleased` section into the versioned entry and copies the prepared changelog back to `.pi/docs/CHANGELOG.md` so the next cycle starts clean.
Default release flow: