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
Copy Markdown
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.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@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
Copy Markdown
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.

Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
Comment thread AGENTS.md
### Generated Mocks

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

Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@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
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Apr 2, 2026
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [cli/cli](https://github.com/cli/cli) | minor | `v2.88.1` → `v2.89.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>cli/cli (cli/cli)</summary>

### [`v2.89.0`](https://github.com/cli/cli/releases/tag/v2.89.0): GitHub CLI 2.89.0

[Compare Source](cli/cli@v2.88.1...v2.89.0)

#### :copilot: `gh agent-task` now works on ghe.com tenancies

`gh agent-task` commands previously failed with `401 Unauthorized` for users on ghe.com tenancy hosts because the Copilot API URL was hardcoded. The URL is now resolved dynamically per host, so `gh agent-task` works correctly regardless of your GitHub hosting environment.

#### Experimental new prompter

A new TUI-based prompter powered by [charmbracelet/huh](https://github.com/charmbracelet/huh) is available behind the `GH_EXPERIMENTAL_PROMPTER` environment variable. This is an early preview — try it out and share feedback!

```
export GH_EXPERIMENTAL_PROMPTER=1
```

#### `gh issue create` and `gh issue transfer` no longer require extra token scopes

`gh issue create` and `gh issue transfer` previously fetched repository fields they didn't need, which could require additional token scopes. These commands now fetch only the minimal fields necessary for issue operations.

#### What's Changed

##### ✨ Features

- `gh pr create`, `gh issue create`, `gh issue edit`: search-based assignee selection and login-based mutation on github.com by [@&#8203;BagToad](https://github.com/BagToad) in [#&#8203;13009](cli/cli#13009)
- Add experimental huh-only prompter gated by `GH_EXPERIMENTAL_PROMPTER` by [@&#8203;BagToad](https://github.com/BagToad) in [#&#8203;12859](cli/cli#12859)

##### 🐛 Fixes

- fix(agent-task): resolve Copilot API URL dynamically for ghe.com tenancies by [@&#8203;BagToad](https://github.com/BagToad) in [#&#8203;12956](cli/cli#12956)
- fix(issue): avoid fetching unnecessary fields in `issue create` and `issue transfer` by [@&#8203;babakks](https://github.com/babakks) in [#&#8203;12884](cli/cli#12884)
- fix: resolve data race in codespaces port forwarder by [@&#8203;Lslightly](https://github.com/Lslightly) in [#&#8203;13033](cli/cli#13033)

##### 📚 Docs & Chores

- Record agentic invocations in User-Agent header by [@&#8203;williammartin](https://github.com/williammartin) in [#&#8203;13023](cli/cli#13023)
- docs: clarify that `gh pr edit --add-reviewer` can re-request reviews by [@&#8203;joshjohanning](https://github.com/joshjohanning) in [#&#8203;13021](cli/cli#13021)
- Add AGENTS.md by [@&#8203;williammartin](https://github.com/williammartin) in [#&#8203;13024](cli/cli#13024)
- Fix typo: remove extra space in README.md link by [@&#8203;realMelTuc](https://github.com/realMelTuc) in [#&#8203;12725](cli/cli#12725)
- Align triage.md with current triage process by [@&#8203;tidy-dev](https://github.com/tidy-dev) in [#&#8203;13030](cli/cli#13030)
- Remove auto-labels from issue templates by [@&#8203;tidy-dev](https://github.com/tidy-dev) in [#&#8203;12972](cli/cli#12972)
- Consolidate actor-mode signals into `ApiActorsSupported` by [@&#8203;BagToad](https://github.com/BagToad) in [#&#8203;13025](cli/cli#13025)
- Fix acceptance test failures: git identity, headRepository JSON, obsolete traversal test by [@&#8203;BagToad](https://github.com/BagToad) in [#&#8203;13037](cli/cli#13037)

##### :dependabot: Dependencies

- chore(deps): bump google.golang.org/grpc from 1.79.2 to 1.79.3 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;12963](cli/cli#12963)
- chore(deps): bump github.com/google/go-containerregistry from 0.20.7 to 0.21.3 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;12962](cli/cli#12962)
- chore(deps): bump github.com/zalando/go-keyring from 0.2.6 to 0.2.8 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;13031](cli/cli#13031)
- chore(deps): bump microsoft/setup-msbuild from 2.0.0 to 3.0.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;13005](cli/cli#13005)
- chore(deps): bump mislav/bump-homebrew-formula-action from 3.6 to 4.1 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;13004](cli/cli#13004)
- chore(deps): bump azure/login from 2.3.0 to 3.0.0 by [@&#8203;dependabot](https://github.com/dependabot)\[bot] in [#&#8203;12951](cli/cli#12951)

#### New Contributors

- [@&#8203;joshjohanning](https://github.com/joshjohanning) made their first contribution in [#&#8203;13021](cli/cli#13021)
- [@&#8203;realMelTuc](https://github.com/realMelTuc) made their first contribution in [#&#8203;12725](cli/cli#12725)
- [@&#8203;Lslightly](https://github.com/Lslightly) made their first contribution in [#&#8203;13033](cli/cli#13033)

**Full Changelog**: [v2.88.1...v2.89.0](cli/cli@v2.88.1...v2.89.0)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My45MS40IiwidXBkYXRlZEluVmVyIjoiNDMuOTEuNCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90IiwiYXV0b21hdGlvbjpib3QtYXV0aG9yZWQiLCJkZXBlbmRlbmN5LXR5cGU6Om1pbm9yIl19-->
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