Document developer workflow conventions - #14
Conversation
…UDE.md Derived branch naming, commit message style, attribution, and PR body conventions from actual git/PR history instead of inventing new ones, and gave Claude Code sessions a root-level entrypoint matching mcp/CLAUDE.md's canon-plus-summary pattern. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2d9da12275
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| state or another open PR (see PR #13). This should satisfy | ||
| `.github/PULL_REQUEST_TEMPLATE.md`'s checklist directly — fill it in, don't | ||
| leave it as unchecked boilerplate. |
There was a problem hiding this comment.
Preserve the required PR template sections
When an agent follows this new PR-body guidance, it will produce only Summary/Verification/optional GitHub context, but .github/PULL_REQUEST_TEMPLATE.md still requires the Layer, Checks, and Safety checklists. Saying this shape “should satisfy” the checklist makes future PRs omit those required boxes instead of filling them, so the workflow docs should either retain those template sections or explicitly instruct agents to fill the template alongside the summary.
Useful? React with 👍 / 👎.
Summary
AGENTS.mdcovering branch naming, commit message style, attribution, and PR body structure — derived from this repo's actualgit log/gh pr listhistory, not invented from a template.claude/<topic-slug>as the branch prefix for Claude Code sessions, mirroring the repo's establishedcodex/<topic-slug>convention (no Claude-specific prefix existed before).maindoes not carry forward to later commits.CLAUDE.md(didn't exist before), following the canon-plus-summary pattern already used bymcp/CLAUDE.md/mcp/AGENTS.md:AGENTS.mdstays canonical,CLAUDE.mdis a condensed Claude-specific entrypoint with the same workflow essentials plus local commands.Verification
./scripts/safe-gate— MCP tests, control-plane tests (portable mode), agent docs sync drift, whitespace hygiene: all green.GitHub context