isabella232 / weallbehave

CODE_OF_CONDUCT.md generator

weallbehave

weallbehave is a command-line tool for automatically generating and updating the CODE_OF_CONDUCT.md for your projects.

You can configure the maintainers that will enforce the CoC by adding author and contributors fields to package.json. Currently email and twitter are supported. You can exclude maintainers from enforcement duties by adding "coc-enforcer": false to their author/contributors entry.

Install

Locally to your npm project (recommended):

$ npm install --save-dev weallbehave

Globally:

$ npm install -g weallbehave

Example

npm repo

// package.json
{
  "scripts": {
    "update-coc": "weallbehave -o . && git add CODE_OF_CONDUCT.md && git commit -m 'docs(coc): updated CODE_OF_CONDUCT.md'"
  },
  "author": {
    "name": "Alice",
    "email": "[email protected]",
    "twitter": "@socialistengineering"
  },
  "contributors": [
    {
      "name": "Bob",
      "email": "[email protected]",
      "coc-enforcer": false
    },
    {
      "name": "Catherine",
      "email": "[email protected]"
    }
  ]
}
// Now you can do `npm run update-coc` any time you
// bump your `weallbehave` 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 `coc.md`
$ weallbehave > coc.md

# Write a CODE_OF_CONDUCT.md document to the ./foo dir.
$ weallbehave -o ./foo