open-source-prep

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.

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.

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.

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.

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.