AGENTS.md: add Communicating with the User conventions#816
Closed
ptr727 wants to merge 1 commit into
Closed
Conversation
Reference every PR as a clickable markdown link (never a bare #N), and present input requests as a numbered list so the user can reply per number. Mirrors the canonical ProjectTemplate rule.
There was a problem hiding this comment.
Pull request overview
Adds a new documentation section to AGENTS.md that standardizes how contributors/agents communicate with users: always linking PRs/issues/commits as clickable Markdown links, and formatting multi-question prompts as numbered lists for easier, per-item replies.
Changes:
- Documented a rule to reference PRs/issues/commits using clickable Markdown links (not bare
#N). - Documented a rule to present 2+ questions/options as a numbered list when requesting user input.
Owner
Author
|
Superseded by #817, which carries the identical change as an SSH-signed commit. This PR's commit was created via the GitHub contents API with a PAT (unsigned), and the |
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.
Adds a Communicating with the User section to AGENTS.md, mirroring the canonical ProjectTemplate rule (ptr727/ProjectTemplate#268):
#N; same for issues and commits.Additive only; no existing wording changed. New H2 after
PR Review Etiquette, beforeWorkflow YAML Conventions. CRLF preserved.🤖 Generated with Claude Code