best-practices-readme

Installation
SKILL.md

Best Practices: README

Use this skill to make a README useful to a developer landing cold in a repo or skill directory. The goal is not a pitch deck. The goal is a friendly map that answers: what is this, why does it exist, where do I start, what can I trust, and what is intentionally not proven here?

Core Contract

A good README is:

  1. Welcoming: human, light, direct, and specific.
  2. Navigable: the first screen gets readers to the right directory, file, command, or artifact.
  3. Contract-aware: README.md explains; SKILL.md governs runtime.
  4. Evidence-aware: proof claims name commands, artifacts, screenshots, reports, receipts, or explicitly state non-claims.
  5. Public-safe: public docs expose reusable patterns, not secrets, credentials, regulated data, or private runtime details.
Installs
1
GitHub Stars
7
First Seen
Aug 26, 2026
best-practices-readme — grahama1970/agent-skills