# contribs

> Generate contributing guidelines for a new project.

Latest version **2.0.0** (published 2022-12-21) · CC0-1.0 license · 0 weekly downloads

## Install

```sh
npm install contribs
pnpm add contribs
yarn add contribs
bun add contribs
```

Provides the command `contribs`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2022-12-21 |
| First published | 2016-03-21 |
| Weekly downloads | 0 |
| License | CC0-1.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Nate Goldman |
| Maintainers | ungoldman |
| Keywords | CONTRIBUTING.md, collaborators, conduct, contribs, contributing, contributing.md, contributions, contributors, guidelines |

## Links

- npm: https://www.npmjs.com/package/contribs
- Repository: https://github.com/ungoldman/contribs
- Homepage: https://github.com/ungoldman/contribs#readme
- Issues: https://github.com/ungoldman/contribs/issues
- npm.io page: https://npm.io/package/contribs

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2022-12-21
- 1.1.0 — 2016-10-03
- 1.0.2 — 2016-03-28
- 1.0.1 — 2016-03-21
- 1.0.0 — 2016-03-21

## README

# contribs

Generate contributing guidelines for a new project.

[![npm][npm-image]][npm-url]
[![downloads][downloads-image]][npm-url]

[npm-image]: https://img.shields.io/npm/v/contribs.svg
[npm-url]: https://www.npmjs.com/package/contribs
[downloads-image]: https://img.shields.io/npm/dm/contribs.svg

## About

This is a tiny terminal program for creating [contributing guidelines](https://help.github.com/articles/setting-guidelines-for-repository-contributors/) for a new open source project.

## Usage

The `contribs` command pipes the contents of the `CONTRIBUTING.md` file in this repository to [`stdout`](https://nodejs.org/api/process.html#process_process_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](CONTRIBUTING.md) before getting started.

## License

[CC-1.0](LICENSE.md)

---
_Source: https://npm.io/package/contribs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._