document-crates
Skill887 starsChanged 29 days agoMITView on GitHub
Plan, create, or update README.md and CONTRIBUTING.md files, especially crate documentation. Use before planning or editing either filename.
In this repository22 other files it gives its agents.
- AGENTS.mdAGENTS.md
- eng/tools/generate_api/AGENTS.mdAGENTS.md
- samples/AGENTS.mdAGENTS.md
- sdk/core/AGENTS.mdAGENTS.md
- sdk/cosmos/AGENTS.mdAGENTS.md
- sdk/cosmos/azure_data_cosmos_emulator/AGENTS.mdAGENTS.md
- sdk/cosmos/docs/AGENTS.mdAGENTS.md
- agentic-workflowsSkill
- analyze-codeSkill
- check-spellingSkill
- create-crateSkill
- create-hotfixSkill
- create-perf-testSkill
- create-recorded-testSkill
- export-apiSkill
- lint-markdownSkill
- prepare-releaseSkill
- review-doc-commentsSkill
- update-emitterSkill
- update-rustSkill
- cosmos-design-structSkill
- cosmos-pre-commit-validationSkill
The file
We split this skill into the rules it gives an agent
11 rules. About 0 are common, 7 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈7
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
Read the target and applicable instructions.
- Distinctive: line 13
Keep consumer guidance in README.
- Distinctive: line 39
Keep this order for service clients.
- Very specific: line 44
Use actual crate/API/product URLs.
- Distinctive: line 45
Document supported authentication, endpoints, features, and limitations accurately.
- Very specific: line 46
Keep examples consumer-focused.
- Very specific: line 47
Use rust no_run for placeholder examples.
- Distinctive: line 51
Start with a repository contribution-guide link.
- Distinctive: line 61
Do not include credentials, private payloads, session logs, or transient run status.
- Very specific: line 67
Check links, heading order, API accuracy, and preserved example labels.
- Distinctive: line 69
Run README tests if executable snippets changed.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill 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
Document crates
- Read the target and applicable instructions. For crate docs, use Key Vault secrets as the published template; read only relevant sections.
- Apply the crate template below to crate docs, not repository/tool guides. Preserve existing purpose and layout for non-crate files.
- Keep consumer guidance in README; contributor workflows in a sibling CONTRIBUTING. Avoid duplication; link shared repository guidance.
README order
# Azure <service> client library for Rust
<consumer overview>
[Source code] | [Package (crates.io)] | [API reference documentation] | [Product documentation]
## Getting started
### Install the package
### Prerequisites
### Install dependencies
### Authenticate the client
### Instantiate a client
## Key concepts
## Examples
### <primary scenario>
## Troubleshooting
### General
## Contributing
<standard repository contribution link, CLA, Code of Conduct prose>
<!-- LINKS -->
<reference-style definitions>- Keep this order for service clients; add service-specific subsections as needed. Omit inapplicable setup steps for non-service crates; do not invent requirements.
- Copy Contributing prose verbatim from the published template. Link its
CONTRIBUTING.mdreference to the repository-root GitHub URL, not the sibling. Retain the CLA and Code of Conduct links. - Use actual crate/API/product URLs; Rustdoc links target the published crate. Document supported authentication, endpoints, features, and limitations accurately.
- Keep examples consumer-focused; preserve README-test fence labels and bindings.
Use
rust no_runfor placeholder examples; match existing tested snippet fences.
CONTRIBUTING content
Start with a repository contribution-guide link. Include only applicable crate-specific details, in this order:
- Prerequisites and local setup: tools, permissions, environment-variable names.
- Generation: pinned inputs/tooling, commands, customization ownership and caveats.
- Build and offline checks: package-scoped commands,
--all-featuresfor tests. - Integration tests: provisioning, record/playback commands, fixtures, ignored-case reasons, resource counts/cost implications, cleanup, and recording publication.
- Contributor troubleshooting.
Do not include credentials, private payloads, session logs, or transient run status. Link shared workflows instead of copying them. Do not run live tests or provision resources merely to validate documentation.
Finish
Check links, heading order, API accuracy, and preserved example labels. At the end,
use lint-markdown and check-spelling for changed files; reuse unchanged results.
Run README tests if executable snippets changed.
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.

