Skip to content

docs(agents): require lean code, docs over comments, and conventional commits - #69

Merged
not-varram merged 1 commit into
mainfrom
docs/agent-guidance-comments-commits
Sep 4, 2026
Merged

docs(agents): require lean code, docs over comments, and conventional commits#69
not-varram merged 1 commit into
mainfrom
docs/agent-guidance-comments-commits

Conversation

@not-varram

Copy link
Copy Markdown
Contributor

Summary

  • Code style now requires writing only the code the change needs and comments only where the code cannot say it; explanations belong in docs/.
  • New Commits section: Conventional Commits for commit messages and PR titles (squash-merge makes the PR title the commit on main), with types, repo-specific scopes, header and body rules, breaking-change and revert format, and examples from this repo's history.
  • AGENTS.md and CLAUDE.md stay identical.

Checks

  • make public-audit passes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01DnKVTrzZFyhV11HT8TFDB7

… commits

AGENTS.md and CLAUDE.md said comments explain constraints but never said
where everything else goes, and had no commit message rules, so agents
mixed styles on main. Both files now state that only necessary code and
comments ship, that explanations live in docs/, and that commit messages
and PR titles follow Conventional Commits with repo-specific scopes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DnKVTrzZFyhV11HT8TFDB7
@not-varram
not-varram added this pull request to the merge queue Sep 4, 2026
Merged via the queue into main with commit b898e51 Sep 4, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant