Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/generate/generate-contributing

Generate a contributing.md file for a project. Can also be used as a building block to add this functionality to another generator.
https://github.com/generate/generate-contributing

build-tool cli command-line contributing contributing-generator contributing-guidelines contributing-md contributing-template create generate generator gulp make plugin scaffold scaffolding task-runner templates yeoman yo

Last synced: 3 months ago
JSON representation

Generate a contributing.md file for a project. Can also be used as a building block to add this functionality to another generator.

Host: GitHub
URL: https://github.com/generate/generate-contributing
Owner: generate
License: mit
Created: 2016-06-21T19:06:40.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2018-01-25T12:35:19.000Z (almost 7 years ago)
Last Synced: 2024-04-26T16:21:42.661Z (9 months ago)
Topics: build-tool, cli, command-line, contributing, contributing-generator, contributing-guidelines, contributing-md, contributing-template, create, generate, generator, gulp, make, plugin, scaffold, scaffolding, task-runner, templates, yeoman, yo
Language: JavaScript
Homepage:
Size: 270 KB
Stars: 18
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE

Awesome Lists containing this project

README

        










Generate a contributing.md, issue_template.md, or pull_request_template.md file for a project. Can be generated from the command line when Generate is installed globally, or as a plugin inside another generator.

# generate-contributing

[![NPM version](https://img.shields.io/npm/v/generate-contributing.svg?style=flat)](https://www.npmjs.com/package/generate-contributing) [![NPM monthly downloads](https://img.shields.io/npm/dm/generate-contributing.svg?style=flat)](https://npmjs.org/package/generate-contributing) [![Build Status](https://img.shields.io/travis/generate/generate-contributing.svg?style=flat)](https://travis-ci.org/generate/generate-contributing)

![generate-contributing demo](https://raw.githubusercontent.com/generate/generate-contributing/master/docs/demo.gif)

- [Getting started](#getting-started)

  * [Install](#install)

  * [CLI](#cli)

  * [Help](#help)

- [Available tasks](#available-tasks)

  * [contributing](#contributing)

  * [contributing:it](#contributingit)

  * [contributing:itb](#contributingitb)

  * [contributing:itd](#contributingitd)

  * [contributing:pr](#contributingpr)

  * [contributing:prd](#contributingprd)

- [Next steps](#next-steps)

  * [Running unit tests](#running-unit-tests)

  * [Publishing your generator](#publishing-your-generator)

- [About](#about)

  * [What is "Generate"?](#what-is-generate)

  * [Related projects](#related-projects)

  * [Community](#community)

  * [Contributors](#contributors)

  * [Contributing](#contributing)

  * [Running tests](#running-tests)

  * [Author](#author)

  * [License](#license)

_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_

## Getting started

### Install

**Installing the CLI**

To run the `readme` generator from the command line, you'll need to install [Generate][] globally first. You can do that now with the following command:

```sh

$ npm install --global generate

```

This adds the `gen` command to your system path, allowing it to be run from any directory.

**Install generate-contributing**

Install this module with the following command:

```sh

$ npm install --global generate-contributing

```

### CLI

Run this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:

```sh

$ gen readme

```

**What you should see in the terminal**

If completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:

```sh

[00:44:21] starting ...

...

[00:44:22] finished ✔

```

If you do not see one or both of those events, please [let us know about it](../../issues).

### Help

To see a general help menu and available commands for Generate's CLI, run:

```sh

$ gen help

```

## Available tasks

All available tasks for this generator.

### [contributing](generator.js#L26)

Generate a `contributing.md` file.

**Example**

```sh

$ gen contributing

$ gen contributing --dest ./docs

```

### [contributing:it](generator.js#L42)

Generate an `issue_template.md` file to the `.github/` directory, or specified `--dest`.

**Example**

```sh

$ gen contributing:it

$ gen contributing:it --dest ./docs

# also aliased as the following (mostly for API usage)

$ gen contributing:issue_template

```

### [contributing:itb](generator.js#L59)

Generate a bare bones `issue_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/issue_template_basic.md).

**Example**

```sh

$ gen contributing:itb

$ gen contributing:itb --dest ./docs

# also aliased as the following (mostly for API usage)

$ gen contributing:issue_template_detailed

```

### [contributing:itd](generator.js#L76)

Generate a detailed `issue_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/issue_template_detailed.md)

**Example**

```sh

$ gen contributing:itd

$ gen contributing:itd --dest ./docs

# also aliased as the following (mostly for API usage)

$ gen contributing:issue_template_detailed

```

### [contributing:pr](generator.js#L93)

Generate a `pull_request_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/pull_request_template.md).

**Example**

```sh

$ gen contributing:pr

$ gen contributing:pr --dest ./docs

# also aliased as the following (mostly for API usage)

$ gen contributing:pr_template

```

### [contributing:prd](generator.js#L110)

Generate a detailed `pull_request_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/pull_request_template_detailed.md).

**Example**

```sh

$ gen contributing:prd

$ gen contributing:prd --dest ./docs

# also aliased as the following (for API usage, when it helps to be explicit in code)

$ gen contributing:pr_template_detailed

```

Visit Generate's [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).

## Next steps

### Running unit tests

It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:

```sh

$ npm install && test

```

### Publishing your generator

If you're tests are passing and you're ready to publish your generator to [npm](https://www.npmjs.com), you can do that now with the following command:

**Are you sure you're ready?!**

Let's go!

```sh

$ npm publish

```

## About

### What is "Generate"?

Generate is a command line tool and developer framework for scaffolding out new GitHub projects using [generators](https://github.com/generate/generate/blob/master/docs/generators.md) and [tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).

Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for [gulp](http://gulpjs.com), [base](https://github.com/node-base/base) and [assemble](https://github.com/assemble/assemble) plugins, and much more.

**For more information**:

* Visit the [generate project](https://github.com/generate/generate/)

* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)

* Find [generators on npm](https://www.npmjs.com/browse/keyword/generate-generator) (help us [author generators](https://github.com/generate/generate/blob/master/docs/micro-generators.md))

### Related projects

* [generate-eslint](https://www.npmjs.com/package/generate-eslint): Generate a new `.eslintrc.json` or `.eslintignore` file from a pre-defined or user-defined template. Can be… [more](https://github.com/generate/generate-eslint) | [homepage](https://github.com/generate/generate-eslint "Generate a new `.eslintrc.json` or `.eslintignore` file from a pre-defined or user-defined template. Can be used from the command line when installed globally, or as a plugin in your own generator.")

* [generate-license](https://www.npmjs.com/package/generate-license): Generate a license file. Choose any of the licenses supported by https://github.com/github/choosealicense.com. | [homepage](https://github.com/generate/generate-license "Generate a license file. Choose any of the licenses supported by https://github.com/github/choosealicense.com.")

* [generate-project](https://www.npmjs.com/package/generate-project): Scaffold out complete code projects from the command line, or use this generator as a… [more](https://github.com/generate/generate-project) | [homepage](https://github.com/generate/generate-project "Scaffold out complete code projects from the command line, or use this generator as a plugin in other generators to provide baseline functionality.")

* [generate-travis](https://www.npmjs.com/package/generate-travis): Generate a .travis.yml file to the cwd or specified directory. Install globally and run with… [more](https://github.com/generate/generate-travis) | [homepage](https://github.com/generate/generate-travis "Generate a .travis.yml file to the cwd or specified directory. Install globally and run with generate's CLI, or use as a component in your own generator.")

### Community

Bigger community means more plugins, better support and more progress. Help us make Generate better by spreading the word:

* Show your love by starring the project

* Tweet about Generate. Mention using `@generatejs`, or use the `#generatejs` hashtag

* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) with the `generatejs` tag

* Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)

* If you publish a generator, to make your project as discoverable as possible, please add the unique keyword `generategenerator` to your project's package.json.

### Contributors

| **Commits** | **Contributor** | 

| --- | --- |

| 30 | [jonschlinkert](https://github.com/jonschlinkert) |

| 3 | [pointnet](https://github.com/pointnet) |

### Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.

### Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

```sh

$ npm install && npm test

```

### Author

**Jon Schlinkert**

* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)

* [github/jonschlinkert](https://github.com/jonschlinkert)

* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)

### License

Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).

Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on January 25, 2018._