Skip to content

Guide AI agents to use private repository for staff docs PRs - #4353

Open
karensawrey wants to merge 1 commit into
mainfrom
docs-contribution-guardrail
Open

Guide AI agents to use private repository for staff docs PRs#4353
karensawrey wants to merge 1 commit into
mainfrom
docs-contribution-guardrail

Conversation

@karensawrey

Copy link
Copy Markdown
Contributor

Description

AI agents modifying or analyzing this repository may create follow-up PRs for the Buildkite documentation site. Those PRs must go to buildkite/docs-private when made on behalf of Buildkite staff.

Add guidance to AGENTS.md that defaults to docs-private, with buildkite/docs reserved for known external contributors. Require agents to verify the push destination and PR base repository, and ask for guidance if the required destination is unavailable.

Documentation maintained in this repository stays in buildkite/agent.

Context

Applies the internal documentation contribution policy.

Public documentation

Status: not needed

Testing

Documentation-only change. git diff --check passed; Go tests and formatting were not run.

  • Tests have run locally (with go test ./...).
  • Code is formatted (with go tool gofumpt -extra -w .)

Disclosures / Credits

Amp drafted the AGENTS.md guidance update and this PR description based on my initial instructions and further feedback.

## Description

AI agents modifying or analyzing this repository may create follow-up PRs for the Buildkite documentation site. Those PRs must go to `buildkite/docs-private` when made on behalf of Buildkite staff.

Add guidance to `AGENTS.md` that defaults to `docs-private`, with `buildkite/docs` reserved for known external contributors. Require agents to verify the push destination and PR base repository, and ask for guidance if the required destination is unavailable.

Documentation maintained in this repository stays in `buildkite/agent`.

## Context

Applies the documentation contribution policy discussed in:
https://ampcode.com/threads/T-01a08493-83f0-72fb-9188-95c1fa09798a

## Public documentation

**Status:** not needed

## Testing

Documentation-only change. `git diff --check` passed; Go tests and formatting were not run.

- [ ] Tests have run locally (with `go test ./...`).
- [ ] Code is formatted (with `go tool gofumpt -extra -w .`)

## Disclosures / Credits

Amp drafted the AGENTS.md guidance update and this PR description based on the author's instructions and feedback.
@karensawrey
karensawrey requested review from a team as code owners September 9, 2026 07:14
@karensawrey karensawrey added documentation internal Non-user facing, internal change. labels Sep 9, 2026

@buildsworth-bk-app buildsworth-bk-app Bot 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.

I found no actionable concerns. This changes executable agent guidance for selecting a publication repository, so it still needs a human sanity-check.

Want to dig deeper?

Paste this into your agent to explore the findings from this review's Buildkite build:

Download the buildsworth logs from build 27390, then answer my questions about the findings.

Install the reading-buildsworth-logs skill to run this.

About buildsworth

Model: gpt-5.6-sol with xhigh thinking.

How to request a review: Comment @buildsworth-bk review on the PR, or request buildsworth-bk as a reviewer.

Risk labels (how buildsworth classifies risk) — buildsworth classifies risk itself from the diff. Unless repository policy already allows L2 approval, grant it by mentioning @buildsworth-bk (see approval ceiling and L2 approval grant):

  • L1 — Low risk (dep bumps, docs/copy, lockfiles, small presentational fixes). buildsworth may approve by default.
  • L2 — Standard risk (new UI, additive API fields, refactors). Approved only when repository policy or a verified grant allows it; otherwise comment-only.
  • L3 — High risk (auth, migrations, payments, secrets, perf-critical pipeline paths). Human review always required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation internal Non-user facing, internal change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant