How to write a README for a private GitHub repo.
A private repository README should help the next trusted developer run, configure, deploy, and maintain the project without leaking secrets or relying on tribal knowledge.
Private repo README checklist
Start with access assumptions
Private repos often depend on permissions, organization access, private packages, or service accounts. State who can run the project and what access they need.
Document safe environment setup
List environment variable names, OAuth callback URLs, webhook endpoints, and service dependencies without exposing secret values.
Explain local run commands
Put install, migration, seed, dev, test, and build commands near the top so the next developer can verify the project quickly.
Add deployment and maintenance notes
Private repos are often production apps. Include hosting provider notes, cron jobs, database migrations, logs, and operational gotchas.
Private repository README outline
# Project Name Private client/internal project summary. ## Access - GitHub organization access required - Private package registry access required - Staging dashboard access required ## Local Setup ```bash npm install npm run db:migrate npm run dev ``` ## Environment Variables DATABASE_URL= GITHUB_CLIENT_ID= GITHUB_CLIENT_SECRET= WEBHOOK_SECRET= ## Deployment Describe hosting, database, cron jobs, migrations, and rollback notes.