Open Source Your Project
A comprehensive playbook for open sourcing your project the right way. From preparation to launch to ongoing maintenance.
Phases & Tasks
Remove all secrets, API keys, personal data
1hCheck env files, config, git history. Use git-filter-branch or BFG if needed.
Choose license (MIT for permissive, GPL for copyleft)
15mMIT is most common for open source. GPL if you want derivative works to stay open.
Add LICENSE file
5mCreate LICENSE file in root with full license text.
Write comprehensive README
2hInclude: what it is, why it exists, how to install, how to use, examples.
Add CONTRIBUTING.md
45mHow to report bugs, submit PRs, code style, testing requirements.
Add CODE_OF_CONDUCT.md
15mUse Contributor Covenant or write your own. Sets expectations for community.
Write installation guide
1hStep-by-step instructions. Test them on a fresh machine.
Document configuration options
45mList all env vars, config files, and what each option does.
Add usage examples
1h 30mReal-world examples for common use cases. Code samples help.
Create CHANGELOG.md
30mDocument changes for each version. Start with 1.0.0.
Set up GitHub issue/PR templates
30mCreate .github/ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE.md.
Post on Twitter with clear value prop
30mWhat problem does it solve? Include a screenshot or demo GIF.
Submit to Hacker News (Show HN)
15mFormat: Show HN: [Name] – [One-line description]. Be in the comments.
Post in relevant subreddits
30mr/programming, language-specific subreddits, domain-specific communities.
Add to awesome-* lists
45mFind relevant awesome lists on GitHub and submit a PR.
Share in Discord/Slack communities
30mTech communities, programming discords. Follow their rules.
Write a blog post about the journey
2hWhy you built it, lessons learned, technical decisions.
Respond to issues within 48 hours
30mEven "thanks for reporting, will look into it" is helpful.
Review PRs promptly (or explain delays)
1hQuick feedback encourages contributors. Set expectations if you're busy.
Tag releases with semantic versioning
15mMAJOR.MINOR.PATCH. Breaking changes bump major, features bump minor.
Thank contributors publicly
15mMention them in releases, README, or on social media.
Consider adding contributor guidelines
45mIf you get many PRs, document coding style, testing requirements.
Ready to start this playbook?