Skip to content

Allow large mechanical PRs in AGENTS.md and say how to check a change #876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lmac-1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow large mechanical PRs in AGENTS.md and say how to check a change #876

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,23 @@ category from the sidebar, one folder under `docs/`, or one page.
Stop at 20 changed files and open a PR (see `update-content/SKILL.md`).
Translations go in their own PR per locale and do not count toward the 20.

Mechanical changes that the build or a script checks, such as rewriting links
or running Prettier, can go in one PR of any size. Keep that PR to the
mechanical change only, so it stays quick to review.

## Checking a change

Before opening any PR, build the site as CI does. It fails on broken links:

```bash
yarn generate-library
yarn generate-adaptors
yarn build
```

Broken-anchor warnings do not fail the build, and `main` already has some. Fix
only the ones your change adds.

## House style

- Every page has a `title` in its front matter.
Expand Down
Loading