iocraft
Copilot instructions1.6k starsChanged 7 months agoApache-2.0View on GitHub
Follow CONTRIBUTING.md and AGENTS.md. When reviewing pull requests, enforce the rules below. Violations of these rules are blocking. Do not present them as nits, suggestions, optional, or "consider". State plainly that the change must be fixed before the pull request can be merged, and comment on every occurrence, not just the first. Any change to a CHANGELOG.md file outside of the automated release pull requests is blocking. Changelogs are generated from commit messages at release time. Doc comments (/// and…
We split this copilot-instructions.md into the rules it gives an agent
3 rules. About 0 are common, 2 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
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 3
Follow CONTRIBUTING.md and AGENTS.md.
- Very specific: line 44
Don't comment on formatting, clippy lints, or broken intra-doc links.
- Distinctive: line 45
Keep new code consistent with the surrounding code's naming, idioms, and comment density.
≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions 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
Copilot review instructions
Follow CONTRIBUTING.md and AGENTS.md. When reviewing pull requests, enforce the rules below.
Blocking issues
Violations of these rules are blocking. Do not present them as nits, suggestions, optional, or "consider". State plainly that the change must be fixed before the pull request can be merged, and comment on every occurrence, not just the first.
Edits to CHANGELOG.md
Any change to a CHANGELOG.md file outside of the automated release pull requests is blocking. Changelogs are generated from commit messages at release time.
Doc comments that don't belong
Doc comments (/// and //!) are user-facing documentation on docs.rs. Flag any added or modified doc comment that:
- Describes a bug fix, or reassures the reader that a bug no longer happens. Correct behavior is assumed.
- Mentions implementation details such as locks, borrows, wakers, internal writers, private types, or helper functions.
- Restates what the signature already says, such as trait bounds or parameter types.
- Contains maintainer notes, including
XXX:orTODO:notes. These belong in regular//comments.
Examples of doc comment lines that were previously removed for these reasons:
/// A wide character is included once; its continuation columns do not introduce spaces into the extracted text./// Leading Unicode whitespace contributes to the aligned display width./// Bold and light replace each other rather than combining terminal attributes./// Property structs may use defaulted type and const generic parameters.
Acceptable doc additions describe behavior a user can observe and might not expect: panics, errors, clamping of out-of-range input, or new options. Most bug fixes need no doc changes at all. When flagging, suggest deleting the line or moving maintainer-relevant content to a // comment, and point out that explanations of the fix belong in the pull request description.
Comments that narrate the change
Flag // comments that only make sense in the context of this pull request, such as:
- Describing what was changed or fixed (e.g. "now uses...", "fixed so that...", "previously...", "instead of...").
- Referencing the pull request, the review, an issue discussion, or instructions given to an AI agent.
- Restating what the next line of code obviously does.
Comments should explain non-obvious intent or pitfalls for future readers of the code as it stands. // XXX: comments for important pitfalls are encouraged.
Non-blocking guidance
- Bug fixes should usually come with a regression test. If one is missing, ask for it.
- Don't comment on formatting, clippy lints, or broken intra-doc links. CI enforces
cargo fmt --check,cargo clippy -D warnings, andcargo docwith-D warnings. - Keep new code consistent with the surrounding code's naming, idioms, and comment density.
Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.
Of the Copilot instructions files we read, the 2,297 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.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.

