OmniCraft
AGENTS.md1 starsChanged 4 months agoApache-2.0View on GitHub
Guidance for AI agents (Claude Code, Copilot, Cursor, etc.) working in this repository. See CONTRIBUTING.md for the full contributor workflow. Run the pre-commit hook before committing (pre-commit run --all-files, or let it run on staged files via git commit). Fix any issues it reports so the commit lands clean — CI runs the same checks. Never override the author identity with -c user.email=.... The repo's git config already carries the human's real, GitHub-verified email; overriding it with a made-up address…
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 repository9 other files it gives its agents.
- .github/copilot-instructions.mdCopilot instructions
- antigravity-native-e2e-devSkill
- antigravity-sdk-e2e-devSkill
- cli-setup-verifySkill
- copilot-sdk-e2e-devSkill
- cursor-sdk-e2e-devSkill
- fucho-e2e-devSkill
- harness-integration-guideSkill
- pi-native-e2e-devSkill
The file
We split this AGENTS.md into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Run the pre-commit hook before committing (pre-commit run --all-files, or let it run on staged files via git commit).
- Very specific: line 33
When you open a pull request, fill in the repo's PR template at .github/pull_request_template.md (case-sensitive on Linux — note the …
- Distinctive: line 54
Keep comments short and focused on the code, not on the change history.
≈ “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
Agent guidance
Guidance for AI agents (Claude Code, Copilot, Cursor, etc.) working in this
repository. See CONTRIBUTING.md for the full contributor workflow.
Committing
Run the pre-commit hook before committing (pre-commit run --all-files, or
let it run on staged files via git commit). Fix any issues it reports so the
commit lands clean — CI runs the same checks.
Authorship
Never override the author identity with -c user.email=.... The repo's git
config already carries the human's real, GitHub-verified email; overriding it
with a made-up address (e.g. local@omnicraft) silently strips the human's
attribution — GitHub links a commit to an account only when the email matches a
verified one, so an invented address makes the work belong to nobody.
Credit OmniCraft as co-author on every commit an agent writes:
Co-Authored-By: OmniCraft <305612714+Omnicraft-bot@users.noreply.github.com>That address is the Omnicraft-bot account's GitHub noreply, so the commit
lands under its avatar in the repo's Contributors. A model may add its own
trailer alongside it; multiple Co-Authored-By lines are valid and each is
resolved independently.
Pull requests
When you open a pull request, fill in the repo's PR template at
.github/pull_request_template.md (case-sensitive on Linux — note the lowercase
filename). Keep every section and checkbox row so reviewers can skim them.
- Summary — what changed and why.
- Test Plan — how you verified it.
- Demo — a video or images showing the change. Expected on contributor
PRs for UI / frontend changes (check the "UI / frontend change" box under
Type of change) so reviewers can see the new behaviour without checking out
the branch. Use
N/Afor non-visual changes. - Type of change / Test coverage — check all that apply (at least one each).
- Coverage notes — required if you checked "Manual verification completed" or "Not applicable".
Generate the description from the actual diff and this session's context — lead
with the motivation, then the change. Don't pass a --body that skips these
sections.
Code comments
Keep comments short and focused on the code, not on the change history.
- Keep them brief — prefer one or two lines. Avoid comments longer than three lines; if you need more, the code likely needs refactoring or a doc string, not a wall of inline commentary.
- Describe the scenario, not the PR — explain what the code handles or
why it exists, in terms a future reader needs. Don't reference PR numbers,
issue numbers, or ticket IDs (e.g.
#1646,fixes JIRA-123); the scenario should be clear without chasing external links.
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.

