Skip to content

Instantly share code, notes, and snippets.

@broofa
broofa / IdiotsGuide.md
Last active May 13, 2019 20:38
The Idiot's Guide to Managing an OpenSource Project on Github (and NPM)

The Idiot's Guide to Managing an OpenSource Project on Github (and NPM)

This doc attempts to capture some of the more nuanced tips and tricks involved in managing an NPM-based open source project, specifically with an eye toward maintaining a structured release process that limits the pain and surprises you cause your audience.

Preface

Contrary to the title, this guide is going to assume you're not an idiot. In fact, a working knowledge of git, GitHub, and NPM are assumed. Moreover, we're going to gloss over the basic steps involved in creating a project and instead focus on the less-obvious aspects of how you maintain a project. So, things this guide assumes you've done before you got here:

  • Write some useful code
  • Create a github repo for it