Repository navigation
Require agents to follow issue writing guidance - #687
Merged
Merged
Conversation
PR #687: Require agents to follow issue writing guidance3 files, +386 / -208 Scope🟡 594 lines changed. PRs under 400 receive more thorough review. 🟡 Large PR with no linked issue. Structural✅ No structural bloat detected. Slop✅ Slop indicators look low. Static Analysis✅ Oxlint found no issues. CorrectnessNo extraneous code patterns detected. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Agents need one issue contract, not separate instructions for titles and
descriptions. Title wording, description clarity, Quest classification, live
status, overlap, and active implementation are decisions about the same issue
and must stay consistent.
What changes
Before:
Agents read a title-only guide. Description guidance and the shared status audit
were not part of the repository rule.
After:
Agents read one issue-writing guide before creating an issue or changing a Story
or Quest title, description, or classification. The guide keeps distinct title
and description rules while sharing the status audit, active-implementation
protection, refinement interview, and completion audit.
Review guide
Start with:
.agents/issue-writing.mdThen review:
AGENTS.mdrequirementLook carefully at:
factual status corrections.
Quest:prefix andquestlabel.What must stay true
rules and checked by retaining the examples and completion scan from the
merged title guide.
enforced by the description rules, story shape, and active-contract boundary.
AGENTS.mdand checked by the repository reference scan.How to verify it
git diff --cached --checkreports no whitespace errors.rg --hidden -n "issue-titles|issue-descriptions|issue-writing" AGENTS.md .agents README.mdfinds only the new
.agents/issue-writing.mdreference inAGENTS.md.title rules from the merged guide remain present.
Scope
Included
status, and refinement
Intentionally unchanged
Generated or mechanical changes
.agents/issue-titles.mdis replaced by.agents/issue-writing.md; the titlerules remain and the shared material is reorganized around the complete issue.
Scope confirmation