🌐

Open Source Your Project

A comprehensive playbook for open sourcing your project the right way. From preparation to launch to ongoing maintenance.

4phases22tasks~1-2 weeks

Phases & Tasks

  • Remove all secrets, API keys, personal data

    1h

    Check env files, config, git history. Use git-filter-branch or BFG if needed.

  • Choose license (MIT for permissive, GPL for copyleft)

    15m

    MIT is most common for open source. GPL if you want derivative works to stay open.

  • Add LICENSE file

    5m

    Create LICENSE file in root with full license text.

  • Write comprehensive README

    2h

    Include: what it is, why it exists, how to install, how to use, examples.

  • Add CONTRIBUTING.md

    45m

    How to report bugs, submit PRs, code style, testing requirements.

  • Add CODE_OF_CONDUCT.md

    15m

    Use Contributor Covenant or write your own. Sets expectations for community.

  • Write installation guide

    1h

    Step-by-step instructions. Test them on a fresh machine.

  • Document configuration options

    45m

    List all env vars, config files, and what each option does.

  • Add usage examples

    1h 30m

    Real-world examples for common use cases. Code samples help.

  • Create CHANGELOG.md

    30m

    Document changes for each version. Start with 1.0.0.

  • Set up GitHub issue/PR templates

    30m

    Create .github/ISSUE_TEMPLATE and PULL_REQUEST_TEMPLATE.md.

  • Post on Twitter with clear value prop

    30m

    What problem does it solve? Include a screenshot or demo GIF.

  • Submit to Hacker News (Show HN)

    15m

    Format: Show HN: [Name] – [One-line description]. Be in the comments.

  • Post in relevant subreddits

    30m

    r/programming, language-specific subreddits, domain-specific communities.

  • Add to awesome-* lists

    45m

    Find relevant awesome lists on GitHub and submit a PR.

  • Share in Discord/Slack communities

    30m

    Tech communities, programming discords. Follow their rules.

  • Write a blog post about the journey

    2h

    Why you built it, lessons learned, technical decisions.

  • Respond to issues within 48 hours

    30m

    Even "thanks for reporting, will look into it" is helpful.

  • Review PRs promptly (or explain delays)

    1h

    Quick feedback encourages contributors. Set expectations if you're busy.

  • Tag releases with semantic versioning

    15m

    MAJOR.MINOR.PATCH. Breaking changes bump major, features bump minor.

  • Thank contributors publicly

    15m

    Mention them in releases, README, or on social media.

  • Consider adding contributor guidelines

    45m

    If you get many PRs, document coding style, testing requirements.

Ready to start this playbook?

Open Source Your Project - Step-by-Step Playbook