weallcontribute
CONTRIBUTING.md generator
Last updated a year ago by zkat .
CC0-1.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install weallcontribute 
SYNC missed versions from official npm registry.

weallcontribute npm version license Travis AppVeyor Coverage Status

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

Current Tags

  • 1.0.9                                ...           latest (a year ago)

10 Versions

  • 1.0.9                                ...           a year ago
  • 1.0.8                                ...           3 years ago
  • 1.0.7                                ...           3 years ago
  • 1.0.6                                ...           3 years ago
  • 1.0.5                                ...           3 years ago
  • 1.0.4                                ...           3 years ago
  • 1.0.3                                ...           3 years ago
  • 1.0.2                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 21
Last Month 52
Dependencies (2)
Dev Dependencies (4)

Copyright 2014 - 2016 © taobao.org |