Skip to content

Add AGENTS.md#13024

Merged
williammartin merged 2 commits intotrunkfrom
agents-md
Mar 24, 2026
Merged

Add AGENTS.md#13024
williammartin merged 2 commits intotrunkfrom
agents-md

Conversation

@williammartin
Copy link
Member

@williammartin williammartin commented Mar 24, 2026

Description

Adds foundational AGENTS.md to guide agentic development in this repository. I asked GPT 5.4, Opus 4.6, and Sonnet 4.6 to review it for token optimization. I expect we will iterate on this in every PR as we discover necessary prompting changes, but felt like we should land something to begin with.

@williammartin williammartin marked this pull request as ready for review March 24, 2026 17:15
@williammartin williammartin requested a review from a team as a code owner March 24, 2026 17:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an AGENTS.md document intended to guide agentic development and provide a concise “how this repo works” reference for contributors/automation in the GitHub CLI codebase.

Changes:

  • Introduces AGENTS.md with build/test/lint commands and repository architecture notes
  • Documents common command patterns (Options + Factory), JSON output conventions, and testing practices
  • Captures guidance on error handling, feature detection, and API usage patterns

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

### Generated Mocks

Interfaces use `moq`: `//go:generate moq -rm -out prompter_mock.go . Prompter`. Run `go generate ./...` after interface changes.

Copy link
Member

Choose a reason for hiding this comment

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

Could we add another heading about using table test patterns? 🙏

Copy link
Member

@BagToad BagToad left a comment

Choose a reason for hiding this comment

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

LGTM - just a small request in a comment

Copy link
Member

@babakks babakks left a comment

Choose a reason for hiding this comment

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

LGTM. I'd also appreciate if agents are instructed to avoid unnecessary comments, and also add godocs to exported declrations.

@williammartin williammartin merged commit dedb228 into trunk Mar 24, 2026
6 checks passed
@williammartin williammartin deleted the agents-md branch March 24, 2026 19:28
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.

4 participants