mr-boxington
AGENTS.md720 starsChanged 14 days agoMITView on GitHub
When you post AI-contributed GitHub content, including a new Discussion or Issue, a reply, or a PR description or comment, append this disclosure: *AI-assisted — Tool: <tool>; model: <provider>/<model>; version: <version-or-unavailable>.* Use the exact model and version identifiers exposed by the runtime, never guessed values, and unavailable when one is not exposed. Pull request titles must use <type>[optional scope][optional !]: <description>; intermediate commit subjects should use the same format. Start descriptions with a lowercase character or an acronym such as…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository4 other files it gives its agents.
- entire-searchSkill
- jouet-initSkill
- jouet-initSkill
- mbxSkill
The file
We split this AGENTS.md into the rules it gives an agent
7 rules. About 0 are common, 6 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 5
When you post AI-contributed GitHub content, including a new Discussion or Issue, a reply, or a PR description or comment, append this …
- Distinctive: line 34
Never bump a crate version in an ordinary pull request.
- Very specific: line 41
Do not edit CHANGELOG.md files in ordinary pull requests.
- Distinctive: line 43
Only edit a changelog when the user explicitly requests it or when working on the release process itself.
- Distinctive: line 67
Describe the final result: Before requesting review and again after feedback changes the implementation, compare the title and body with …
- Distinctive: line 71
Lead with the user-visible change: Keep the conventional commit format, but name the affected behavior and outcome in the title.
- Distinctive: line 82
Use measured results for performance claims and state how they were measured.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Repository Instructions
AI Disclosure
When you post AI-contributed GitHub content, including a new Discussion or Issue, a reply, or a PR description or comment, append this disclosure: *AI-assisted — Tool: <tool>; model: <provider>/<model>; version: <version-or-unavailable>.* Use the exact model and version identifiers exposed by the runtime, never guessed values, and unavailable when one is not exposed.
Conventional Commits
Pull request titles must use
<type>[optional scope][optional !]: <description>; intermediate commit
subjects should use the same format. Start descriptions with a lowercase
character or an acronym such as CLI, and keep them concise and imperative. Use ! for a breaking change and explain it with a
BREAKING CHANGE: footer.
Breaking markers are commit-wide; a Conventional Commit scope does not limit
them to one crate. Because pull requests are squash-merged, do not use ! or a
BREAKING CHANGE: footer on a pull request that touches mbx unless the CLI
itself requires a major release. A breaking CLI change requires exceptional
justification and explicit maintainer agreement before using either marker. A
breaking API change confined to a pre-1.0 subcrate should be isolated from
mbx changes so release-plz can give that subcrate its permitted 0.x minor
bump without triggering an mbx major bump.
Allowed types are bench, chore, ci, docs, feat, fix, perf,
refactor, revert, security, style, and test.
CI validates the pull request title and re-runs when it is edited. Intermediate commit subjects are not checked because pull requests are squash-merged. CI mechanically checks the allowed type, syntax, and lowercase- or acronym-leading description; imperative mood and breaking-change details remain review rules.
Versions
Never bump a crate version in an ordinary pull request. Release-plz computes versions from the commits touching each crate and writes the bumps in its release pull request. This includes breaking API changes: describe the break in the commit and pull request, then let release-plz choose the version.
Changelogs
- Do not edit
CHANGELOG.mdfiles in ordinary pull requests. The release-plz workflow generates changelog entries in release pull requests. - Only edit a changelog when the user explicitly requests it or when working on the release process itself.
Generated Documentation
docs/cli/ is generated from the usage declarations in
crates/mbx/src/config.rs and crates/mbx/src/cli/. Run
mise run render:docs after changing a setting and commit the result. Do not
hand-edit generated CLI documentation.
Before Pushing
mise run ci is the main gate. mise run format fixes formatting problems.
The Bats suites require the git submodules under test/; the wasm end-to-end
test requires wasm32-unknown-unknown for the toolchain you build with. CI
builds on whatever Rust its runner image ships, so a lint or behavior change in
a new stable shows up there.
PR titles and descriptions are release-note inputs
PR titles and descriptions are source material for release notes, including those generated by Communique. Write them for a mr-boxington user who has not read the diff or this conversation.
- Describe the final result. Before requesting review and again after feedback changes the implementation, compare the title and body with the complete current diff. Rewrite both when the scope changes. Remove abandoned approaches, stale requirements, and claims that the final code or validation no longer supports.
- Lead with the user-visible change. Keep the conventional commit format, but name the affected behavior and outcome in the title. Open the body with the problem or use case and what users can now do. Avoid titles such as "address feedback" or "fix CI" when the PR's actual purpose is a feature or behavior fix. For internal-only work, explain the concrete maintainer or contributor benefit without inventing a user-facing impact.
- Make the change concrete. For new configuration, commands, or APIs, include a small, valid example and explain its result. For a bug fix, describe the trigger and before/after behavior. For visible UI or output changes, include actual before/after screenshots or a short recording when they help reviewers assess the change; CLI input/output snippets are often clearer than terminal screenshots. Use measured results for performance claims and state how they were measured.
- Keep the essential facts in text. Caption screenshots and explain examples. A reader or release-note generator should understand the change without opening an image, following an external link, or reading the diff. Do not fabricate screenshots, output, measurements, or validation results.
- State adoption details when relevant. Include new flags or settings, defaults, supported platforms, experimental status, required dependency versions, and any compatibility changes or migration steps that affect using the feature. Distinguish current behavior from planned follow-ups; do not advertise unfinished work.
- Keep review details proportionate. Summarize meaningful validation and its limitations. Include implementation details only when they explain behavior or a tradeoff reviewers need to assess. Omit agent work logs, intermediate commit summaries, and exhaustive test-command lists. A small fix can be a short paragraph and a test result; screenshots and sections are not mandatory for every PR.
For a hypothetical fix, prefer fix(cache): reuse build artifacts across worktrees
over fix: address review feedback. Its description should show the build commands in two worktrees and explain which compilation work is reused.
These rules supplement the repository's existing commit, release, and disclosure
requirements.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

