Skip to content

docs(agents): tighten PR description conventions - #571

Merged
wesleyboar merged 3 commits into
mainfrom
docs/agents-pr-conciseness
Aug 11, 2026
Merged

docs(agents): tighten PR description conventions#571
wesleyboar merged 3 commits into
mainfrom
docs/agents-pr-conciseness

Conversation

@wesleyboar

Copy link
Copy Markdown
Member

Overview

Tightens AGENTS.md's PR-description guidance and adds a few missing conventions.

Changes

  • updated AGENTS.md Pull Requests section

Testing

  1. Read the updated Pull Requests section for clarity.

wesleyboar and others added 2 commits August 11, 2026 11:45
Adds the ~/.github/PULL_REQUEST_TEMPLATE.md fallback path, tighter
Changes/Overview conciseness rules, guidance on raw PR-link URLs in
the Related section, and quoting/signing replies posted as the user.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Splits the changeset-grouping rule from an explicit "no explanation by
default" rule, since grouping alone didn't stop over-explained bullets.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@wesleyboar wesleyboar changed the title docs(agents): note PR template fallback and reply conventions docs(agents): tighten PR description conventions Aug 11, 2026
Aligns the Changes/Overview bullets with the existing `In "X" section,`
phrasing used for the Related-section rule.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@wesleyboar
wesleyboar merged commit c0f783b into main Aug 11, 2026
@wesleyboar
wesleyboar deleted the docs/agents-pr-conciseness branch August 11, 2026 17:53
wesleyboar added a commit to TACC/Core-CMS that referenced this pull request Aug 11, 2026
)

## Overview

Adds AGENTS.md PR-description conventions that newly exist in
Core-CMS-Custom.

## Related

- TACC/Core-CMS-Custom#571

## Changes

- **added** template fallback path, "Related" raw-URL rule, and
quote-and-sign rule for replying to PR comments
- **added** "Changes" bullet-grouping rule and "Overview" length
guidance

## Testing

1. Read the updated [Pull Requests section](AGENTS.md#pull-requests) for
clarity.
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