docs: working methodology + changelog policy; add AGENTS.md mirror#53
Conversation
Capture how we actually collaborate in this repo so it survives across sessions and agents: - New "Working methodology" section in CLAUDE.md: implement+document together (one PR per concern), branch → PR → always squash-merge (--squash --admin), merge/publish only when explicitly asked, publish via `gh workflow run publish.yml -f dry_run=false`, never create a GitHub Release or git tag. - Releasing section: bump the version line to 0.8.0, describe the workflow-driven publish, and add a "Changelog" subsection — one consolidated CHANGELOG.md entry per version (Keep a Changelog), updated in the same PR as the bump. - Add AGENTS.md as a mirror of CLAUDE.md for non-Claude agents; both files note the sync expectation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Code Review
This pull request introduces a new AGENTS.md file to guide AI coding agents, mirroring the repository's CLAUDE.md file. It also updates CLAUDE.md to keep it in sync, adding a new 'Working methodology' section, updating the 'Releasing' guidelines to reflect version 0.8.0 and the use of the publish.yml workflow, and adding a 'Changelog' section. There are no review comments, and I have no feedback to provide.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
What
Documents how we actually work in this repo, and adds an
AGENTS.mdmirror so non-Claude agents get the same guidance.Why
Our collaboration rhythm (squash-merge, document-with-code, changelog-per-bump, workflow-driven publish, no tags) lived only in conversation and memory. Writing it into
CLAUDE.mdmakes it durable across sessions and tools.Changes
CLAUDE.mdgh pr merge <n> --squash --admin).gh workflow run publish.yml -f dry_run=false; never create a GitHub Release or git tag.0.8.0, publish described as workflow-driven (not localnpm publish), and a new "Changelog" subsection — one consolidatedCHANGELOG.mdentry per version (Keep a Changelog), updated in the same PR as the bump, attributed bychore(release)commit boundaries.AGENTS.md(new)CLAUDE.mdfor any AI agent (Cursor, Codex, Cline, …). Bodies are byte-identical below the header; both files note the sync expectation (edit one, copy across in the same PR).Notes for reviewers
AGENTS.mdis a deliberate copy rather than a pointer, per request — the two are kept in sync by hand, and each flags that.🤖 Generated with Claude Code