github-repo-docs

What problem does it solve?

This Skill eliminates the friction of creating, updating, and auditing GitHub repository documentation that is often incomplete, inconsistent, or misaligned with collaboration best practices, which slows down onboarding, hinders external contributions, and reduces long-term project maintainability.

Core Features & Use Cases

• Document Generation: Creates standard repository files including README, CONTRIBUTING, SECURITY, and GitHub issue/PR templates tailored to the specific project type (library, web app, CLI, monorepo, personal project).
• Repository Auditing: Evaluates existing repositories against mandatory and recommended documentation checklists to identify gaps and prioritize fixes.
• Tone & Style Enforcement: Provides clear writing guidelines to avoid generic marketing language and ensure docs are actionable for both end users and contributors.
• Use Case Example: If you have just launched a new open source Python library and want to prepare it for external contributors, this Skill will generate a complete README with installation steps, usage examples, and a CONTRIBUTING guide, plus flag missing recommended docs like a CHANGELOG.

Quick Start

Use the github-repo-docs skill to generate a full README and CONTRIBUTING guide for your new public Rust CLI tool, following the appropriate structure and tone guidelines.