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

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

Global CLI install

1# Read your repo info from package.json or git
2# and pipe the output to `contribs.md`
3$ weallcontribute > contribs.md
4
5# Write a CONTRIBUTING.md document for org/proj to the ./foo dir.
6$ weallcontribute org/proj -o ./foo