Skip to content

Latest commit

 

History

History
54 lines (45 loc) · 2.68 KB

checklist.md

File metadata and controls

54 lines (45 loc) · 2.68 KB

Open-sourcing checklist

Before making a repository public

  1. Check revision history for secrets and other sensitive content
    • Can be fixed using git rebase [-i] or git filter-branch
  2. Choose an appropriate license and include it as a LICENSE.txt or LICENSE.md file
    • Make sure you understand the implications of choosing different licenses
    • Licenses we currently use:
  3. Write a good README.md
    • Should contain:
      • Short description
      • Demo/screenshot
      • How to use it
      • How to install/deploy it
      • How to contribute
      • How it is licensed
    • HELPq, Gavel, and redisred are good examples

Optional (recommended) steps

  • Write a development guide
    • This makes it easy for new contributors to get started
    • Gavel has a pretty good example
  • Write a CONTRIBUTING.md
  • Set up good issue labels
    • See Gavel for an example
  • Close old / irrelevant issues
  • Set up a "Users" page in the wiki and link to it from the README (cause it's fun to know who uses our software)

Releasing a project

  1. Add the project to code.hackmit.org (hackmit-code repo)
  2. Make sure the project has a designated maintainer who will triage issues and review pull requests

Optional (recommended) steps

  • Write a blog post about it
  • Publicize the software in the Hackcon and Hackathon Hackers Facebook groups
  • Publicize the software on our Twitter and our Facebook page
  • Create some GitHub Issues on easy features or bugfixes to give new contributors a place to start
  • Add the project to the "Software for Hackathons" page in the MLH Hackathon Organizer Guide
  • Add the project to the awesome-hackathons list
  • Post on Hacker News