Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

contribs

ungoldman25CC0-1.02.0.0

Generate contributing guidelines for a new project.

CONTRIBUTING.md, collaborators, conduct, contribs, contributing, contributing.md, contributions, contributors, guidelines

readme

contribs

Generate contributing guidelines for a new project.

npm 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.

Contributing

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

License

CC-1.0