Open Source Repo Checklist

1

GitHub

  • Use the project template
  • Project tags
  • Project Link (often a live demo)
  • License
  • Issues Templates
  • PR Templates
  • README
    • Description
    • Quickstart
    • Table of Contents
    • Image of use
    • Examples of how to use
    • Link to live demo
    • Link to package manager (NPM, Stackage, Rubygems, Brew, &c)
    • Badges (NPM, CI, &c)

Docs

  • Bare API docs
  • Example usage snippets
  • Tutorial building an example app

Checks

  • Set up TravisCI
  • Set up CodeClimate
  • Set up Coveralls

Social

  • Blog post announcing project on the Talk forum
  • Have @FISSIONcodes tweet about it