weallcontribute

weallcontribute

weallcontribute is a command-line tool for automatically generating and updating CONTRIBUTING.md guidelines for your projects.

Install

Locally to your npm project (recommended):

$ npm install --save-dev weallcontribute

Globally:

$ npm install -g weallcontribute

Example

npm repo

// package.json
{
  "scripts": {
    "update-contrib": "weallcontribute -o . && git add CONTRIBUTING.md && git commit -m 'docs(contributing): updated CONTRIBUTING.md'"
  }
}
// Now you can do `npm run update-contrib` any time you
// bump your `weallcontribute` version to bring your docs
// up to date! And you don't need a global install!

Global CLI install

# Read your repo info from package.json or git
# and pipe the output to `contribs.md`
$ weallcontribute > contribs.md

# Write a CONTRIBUTING.md document for org/proj to the ./foo dir.
$ weallcontribute org/proj -o ./foo