Skip to content

Slim down and tighten AGENTS.md - #23778

Merged
MikeMcQuaid merged 1 commit into
mainfrom
update_agents_md
Sep 4, 2026
Merged

Slim down and tighten AGENTS.md#23778
MikeMcQuaid merged 1 commit into
mainfrom
update_agents_md

Conversation

@MikeMcQuaid

Copy link
Copy Markdown
Member
  • Agents keep adding single-use methods and variables and widening diffs, so state the inlining, DRY, YAGNI and minimal diff guidance up front next to the brew lgtm instruction.
  • Hedges such as "where possible" and "when practical" let agents talk themselves out of the guidance, so drop them and make T.must, T.unsafe and .send outright forbidden.
  • Regroup the file into short sections, fold duplicate key guidelines into them and add the Git, TDD, shell redirect and UK spelling conventions agents otherwise get wrong.

  • Have you followed our Contributing guidelines?
  • Have you checked for other open Pull Requests for the same change?
  • Have you explained what your changes do? Performance claims (e.g. "this is faster") must include brew benchmark results.
  • Have you explained why you'd like these changes included, not just what they do?
  • For bug fixes, have you given step-by-step brew commands to reproduce the bug?
  • Have you written new tests (excluding integration tests)? Here's an example.
  • Have you successfully run brew lgtm (style, typechecking and tests) locally?

  • I did not use AI/LLM to create this PR, or I disclosed the tool/model below and reviewed its output; I did not attribute commits to AI and will answer maintainer questions and review comments myself without AI/LLM.

Claude with Fable at Extra High effort, with (lots of) local review, editing and testing.


- Agents keep adding single-use methods and variables and widening
  diffs, so state the inlining, DRY, YAGNI and minimal diff guidance
  up front next to the `brew lgtm` instruction.
- Hedges such as "where possible" and "when practical" let agents
  talk themselves out of the guidance, so drop them and make `T.must`,
  `T.unsafe` and `.send` outright forbidden.
- Regroup the file into short sections, fold duplicate key guidelines
  into them and add the Git, TDD, shell redirect and UK spelling
  conventions agents otherwise get wrong.
Copilot AI balanced review requested due to automatic review settings September 4, 2026 15:35

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

馃煝 Approval recommended

The documentation-only changes are consistent, accurate and aligned with repository tooling.

Pull request overview

Tightens and reorganises contributor guidance for coding agents.

Changes:

  • Prioritises minimal, DRY changes and verification.
  • Adds concise command, Git, code and testing conventions.
  • Consolidates repository structure guidance.
File summaries
File Description
AGENTS.md Reorganises and strengthens agent contribution instructions.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Balanced

馃挕 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

@MikeMcQuaid
MikeMcQuaid added this pull request to the merge queue Sep 4, 2026
Merged via the queue into main with commit f4854f5 Sep 4, 2026
59 checks passed
@MikeMcQuaid
MikeMcQuaid deleted the update_agents_md branch September 4, 2026 16:26
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.

3 participants