github-repo-standards
Skill0 starsChanged 2 months agoMITView on GitHub
Audit a repository's GitHub-facing presentation — default branch naming (`master`), README structure (title, description paragraph, install/usage section, organization section, no template placeholder text, minimum length) and discoverability metadata (Chinese repository description and at least 5 Topics via `gh repo view`). Use when Codex needs to review or fix a README before publishing, or verify a public repo's default branch, Topics and description are set for discoverability. Use project-structure-governance instead for internal file placement and naming.
2 other projects use a version of this.
Adopted by
Most recently taken up by
- farfarfun-skill/project-managerword for word, first seen Sep 16, 2026
- YIMO691/claude-skills-kittheir own version, first seen May 8, 2026
Other versions2 projects use a version of this.
Word for word · 1
- farfarfun-skill/project-manager★ 0100% same
Edited · 0
None found.
Wrote their own version · 1
- YIMO691/claude-skills-kit★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository2 other files it gives its agents.
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are 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.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
Run from this skill directory:
- Very specific: line 20
Add --check-topics to also verify the repository's GitHub-side default branch, description and Topics through gh repo view:
- Very specific: line 28
Use --format json for machine consumption.
- Distinctive: line 32
Read github-repo-standard.md before writing or fixing a README, or before deciding what to put in a repository's description/Topics.
≈ “Common” is an estimate: at least 1 in 5 of the 372,429 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
GitHub Repo Standards
Judge whether a repository's public-facing surface — its README and GitHub Topics/description — gives a newcomer enough to understand and install the project. Do not judge product correctness or internal file layout; those belong to other checkers.
Audit A Repository
Run from this skill directory:
python3 scripts/github_repo_checker.py --workspace /path/to/repo --fail-on reviseThis checks README.md plus the default branch: the README needs an # title, a non-badge description paragraph near the top, an install/usage section, an organization section (## 关于 <org>, ## 关于组织, ## Organization, ## About Us …) plus the bare organization homepage https://github.com/<owner> somewhere in the README — a repository URL under that owner does not satisfy it — no leftover template placeholder (lorem ipsum, coming soon, <repo-name>, <your-repo>), and a sane minimum length; an upper-case TODO/TBD marker at the start of a line outside code and links is reported at revise rather than block, because a published ## TODO roadmap is legitimate; the default branch must be master, inferred from the local clone (origin/HEAD, else the presence of a master branch, else the current branch) and skipped outside a git repository. It never touches the network.
Add --check-topics to also verify the repository's GitHub-side default branch, description and Topics through gh repo view:
python3 scripts/github_repo_checker.py --workspace /path/to/repo --check-topics --fail-on reviseThis requires gh to be installed and authenticated, and the workspace's origin remote to point at GitHub. Only run it when that is available; omit the flag for a purely local, CI-safe check.
Use --format json for machine consumption.
Apply The Standard
Read github-repo-standard.md before writing or fixing a README, or before deciding what to put in a repository's description/Topics.
Return Results
Return allow, revise, or block, the passed checks, and the missing or weak items with concrete repair actions (e.g. which section to add, which placeholder to remove). Do not claim the README is well-written from a passing structural check; state that coverage is limited to structure and discoverability metadata.
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.

