open-source-prep

Audit open-source repositories for public release readiness.

5|1|Updated May 3, 2026

Search Tags:#audit #GitHub #open-source #code of conduct #repository readiness

Ready to run

npx skills add https://github.com/richardwooding/file-search-on --skill open-source-prep-richardwooding

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: open-source-prep
Source: https://github.com/richardwooding/file-search-on/tree/main/.claude/skills/open-source-prep
Command: npx skills add https://github.com/richardwooding/file-search-on --skill open-source-prep-richardwooding

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gh, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the process of preparing an open-source repository for public release, ensuring all necessary legal, community, and GitHub UX components are in place.

Core Features & Use Cases

Legal Checks: Validates the presence of important legal documents like LICENSE, README, CONTRIBUTING, and CODE_OF_CONDUCT.
Community Standards: Audits for standard community files and GitHub UX elements like issue and PR templates.
Repo Metadata: Checks for proper repository metadata like description, homepage, and topics.
Secret Scan: Scans the git history for leaked secrets.
Use Case: Use this Skill to prepare your repository for its first public release or when taking a private repository public.

Quick Start

Run the audit with python .claude/skills/open-source-prep/scripts/audit.py <repo-root>.

Frequently Asked Questions about open-source-prep

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I audit a GitHub repository for open-source release readiness?▼

To audit a GitHub repository for open-source readiness, run the audit script against your repository root to validate legal documents, community files, GitHub UX elements, metadata, and secrets. This non-destructive process ensures all public release components are properly configured.

What legal documents and community files do I need before making a repository public?▼

Before making a repository public, you need legal documents like LICENSE, README, CONTRIBUTING, and CODE_OF_CONDUCT. You also need community files like issue and PR templates to meet standard GitHub UX elements and pass a repository readiness audit.

Can I scan git history for leaked secrets before taking a private repository public?▼

Yes, you can scan git history for leaked secrets before taking a private repository public. The open-source readiness audit includes a secret scan that checks your repository's git history non-destructively to prevent exposing sensitive data during public release.

Do I need the gh CLI to check repository metadata and topics?▼

Yes, you need the gh CLI to check repository metadata like description, homepage, and topics. The open-source readiness audit requires the gh CLI to access and validate GitHub-specific repository metadata during the automated audit process.

What is the best way to prepare an open-source repository for its first public release?▼

The best way to prepare an open-source repository for its first public release is running a comprehensive readiness audit. This validates legal documents, community standards, GitHub UX templates, repository metadata, and scans git history for secrets in a single non-destructive process.