Skip to content

Stop making reviewers excavate your chat history - #214

Merged
lukealonso merged 1 commit into
mainfrom
docs/require-repo-prose
Nov 5, 2026
Merged

lukealonso merged 1 commit into
mainfrom
docs/require-repo-prose

Conversation

@original-el8

Copy link
Copy Markdown
Collaborator

Repository prose can depend on the author's conversation history even when its code passes review. Add a canonical repo-prose skill with concrete rewrite examples, and require agents to read it on entry, apply it before writing or publishing, and pass it to delegates. The requirement covers code prose, PR descriptions and edits, issue comments, and agent reports.

The commit design checklist now includes prose review, and its existing acknowledgment covers review of the staged skill, changed prose, and final commit message. The hook still validates the checklist acknowledgment; semantic prose review remains the contributor's responsibility. Runtime behavior and package compatibility are unchanged.

Validation: skill validator, relative file links, and staged whitespace checks passed; all 18 existing commit-hook tests passed using an isolated pytest environment. Automated PR prose review is outside this change.

Add a repository prose skill with rules and examples for writing without
conversation history. Require agents to read it on entry, apply it before
writing and publication, and pass it to delegates. Include staged prose and
the final commit message in the existing design-review acknowledgment.

Validation: skill validator and relative-link checks passed; all 18 existing
commit-hook tests passed; git diff --cached --check passed. This documentation
change does not alter runtime behavior. The hook checks acknowledgments,
not semantic writing quality.

Design-Signed-Off-By: Codex (GPT-6); design-review=4d3a
Signed-off-by: Jason Cook <jasonc@maxlyn.com>
@original-el8 original-el8 added documentation Improvements or additions to documentation triage:review Proposed change needs code review; this does not imply merge readiness. labels Nov 5, 2026
@original-el8 original-el8 changed the title Require repository prose review in agent and commit workflows Stop making reviewers excavate your chat history Nov 5, 2026
@lukealonso
lukealonso marked this pull request as ready for review November 5, 2026 20:37
@lukealonso
lukealonso merged commit 972e28e into main Nov 5, 2026
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation triage:review Proposed change needs code review; this does not imply merge readiness.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants