Repository navigation
docs: add command authoring guidelines - #308
Merged
Merged
Conversation
Add reuse, correctness, and user-facing text conventions to AGENTS.md, with a longer checklist in docs/command-authoring.md linked from the maintainers guide. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
sswaminathan-godaddy
requested review from
axburgess-godaddy,
jpage-godaddy,
jpearlman-godaddy,
mguerrero3-godaddy,
qcai-godaddy and
rts1-godaddy
as code owners
October 2, 2026 01:07
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The path-encoding guidance could cause double encoding when using generated clients.
Review effort: Balanced
Findings: 2
Open (2)
What changed in this PR
Adds command-authoring standards for contributors and coding agents.
Changes:
- Documents reuse, security, rendering, and customer-facing text conventions.
- Adds a detailed command-authoring checklist.
- Links the checklist from maintainer onboarding.
| File | Description |
|---|---|
AGENTS.md |
Adds concise command-authoring requirements. |
docs/command-authoring.md |
Adds the expanded checklist and rationale. |
docs/maintainers.md |
Links to the new checklist. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Address review feedback (generated clients already encode path params; checklist applies to standalone commands too) and add conventions for dry-run, next actions, input validation, API result handling, and guides. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Expand the unclear conventions with concrete explanations, join hard-wrapped lines, merge overlapping bullets, and drop the ambiguity rule. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
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.
Summary
AGENTS.md(read by Claude Code, Codex, Cursor, and Copilot code review): extra bullets under Command Patterns, plus new "Reuse Before You Build" and "User-Facing Text" sections.docs/command-authoring.mdwith the longer checklist and rationale (reuse, correctness/security, customer-facing text, guides, PRs).docs/maintainers.md.Docs-only; no code changes.
🤖 Generated with Claude Code