From open-source-hardening-skills
Improves open-source repo docs: polishes README, adds/updates SECURITY.md, CHANGELOG.md, FAQ, architecture notes, LICENSE, CITATION.cff. Use for 'improve docs' or README fixes.
How this skill is triggered — by the user, by Claude, or both
Slash command
/open-source-hardening-skills:oss-docsThis skill is limited to the following tools:
The summary Claude sees in its skill listing — used to decide when to auto-load this skill
Make the repository easier to discover, adopt, and maintain without turning the README into a wall of text.
Make the repository easier to discover, adopt, and maintain without turning the README into a wall of text.
README*, docs folder, contribution guidance, and the final code/test/CI state.Produce:
OSS_DOCS.md with:
SECURITY.md if missing.CHANGELOG.md if missing.LICENSE if the repository already has a chosen license. If license selection is still undecided, record that as a maintainer decision instead of inventing legal terms.CITATION.cff or explicit citation instructions.If the repository already has SECURITY.md, CHANGELOG.md, LICENSE, or CITATION.cff, improve the existing file instead of creating duplicates.
The README checklist must cover at least:
docs/ instead of expanding the README endlessly.SECURITY.md: reporting channel, supported versions if known, what to include in a report.CHANGELOG.md: lightweight "Keep a Changelog" style skeleton is enough if no release history exists yet.LICENSE: required for a real open-source release. If the license has not been chosen yet, surface that gap explicitly instead of guessing.CITATION.cff: add when the repo backs a paper, benchmark, dataset, or model release.Before declaring this stage complete, verify:
OSS_DOCS.md exists and includes README checklist, FAQ draft, architecture notes, and licensing/citation/reproducibility notes.README.md has project purpose, quick start, local verification, contribution entry point, and deeper-doc links.SECURITY.md and CHANGELOG.md exist or were improved in place.LICENSE and CITATION.cff exist; otherwise the missing maintainer decision is explicitly recorded.OSS_DOCS.md exists and records README improvements, FAQ content, architecture notes, reproducibility notes, and deferred documentation.README.md, SECURITY.md, and CHANGELOG.md exist after the pass, either newly added or updated in place.LICENSE and CITATION.cff exist; otherwise the unresolved maintainer decision is recorded.npx claudepluginhub zeyuzhangzyz/open-source-hardening-skillsGuides creation and improvement of README files for open-source or software projects. Follows community best practices for structure, badges, and quick-start sections.
Refreshes README structure and content using git-workspace-review repo context: audits languages, researches exemplars via web search, aligns outlines, applies edits. Use for structural updates.