Generate boilerplate open source contributing guidelines.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.travis.yml
CONTRIBUTING.md
LICENSE.md
README.md
index.js
package.json

README.md

contribs

Generate contributing guidelines for a new project.

npm travis standard downloads

About

This is a tiny terminal program for creating contributing guidelines for a new open source project.

Usage

The contribs command pipes the contents of the CONTRIBUTING.md file in this repository to stdout.

npx contribs > filename.md

-h,--help      print usage info
-v,--version   print version info

Example

npx contribs > CONTRIBUTING.md

You can achieve the same effect as above by copying a random CONTRIBUTING.md file from the internet into your project manually (except you can fork and improve this one).

On OS X you can also run npx contribs | pbcopy and you'll get a copy of the contributing guidelines ready to paste anywhere.

Credit

The contents of this project's CONTRIBUTING.md file are drawn from OPEN Open Source Project, jden's CONTRIBUTING.md, Friends, WebTorrent Desktop, and shigeru.

Contributing

Contributions welcome! Please read the contributing guidelines before getting started.

License

CC-1.0