Skip to content

docs: move shared agent instructions to parent folder #17

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

Merged
NoNamer777 merged 2 commits into from
Sep 27, 2026
Merged

docs: move shared agent instructions to parent folder #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f924b39
docs: move shared agent instructions to parent folder
NoNamer777 Sep 27, 2026
cbbfc81
docs: link contributing guide from agent instructions
NoNamer777 Sep 27, 2026
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
29 changes: 1 addition & 28 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,3 @@
# Agent instructions

## Writing style

- Never hard wrap prose. Write each paragraph or list item on a single line and let the editor wrap it.
- Use US spelling only, for example "color", "behavior", and "initialize".
- Keep every sentence at or under 40 words.
- Pretty print Markdown tables so the columns line up in the source.
- Give every separator line alignment markers (`:---`, `:---:`, or `---:`).
- Carry the separator line from edge to edge of each column, with no spaces between the pipes and the dashes.

Example:

| Option | Default | Description |
|:---------|:---------|:--------------------------|
| `strict` | `true` | Enables all strict checks |
| `target` | `es2025` | Emitted language version |

After creating or updating a file that contains prose, including Markdown files, do reading passes over it until every rule above is satisfied. Fix any violation you find, then read the file again.

## Pull requests

Turn on auto-merge for every pull request you open, so it merges as soon as it is approved and the checks pass.

1. Open the pull request with `gh pr create`.
2. Run `gh pr merge <number> --auto --merge` on it. A merge commit is the only merge method the repository allows.

- A draft cannot have auto-merge. Mark it ready with `gh pr ready <number>` first, then run the command above.
- When the user asks to keep a pull request open, leave auto-merge off. If it is already on, turn it off with `gh pr merge <number> --disable-auto`.
- Release pull requests (`chore: release X.Y.Z`) come from the Prepare release workflow, which turns on auto-merge itself. Do not prepare a release commit by hand. The `tag` job of the Push main workflow tags their merge commit, which starts the release.
Read [CONTRIBUTING.md](CONTRIBUTING.md) for the layout, the checks, the release steps, and the commit and branch conventions.
Loading