Repository files navigation

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.

• Getting started
  • Install
  • CLI
  • Help
• Available tasks
  • contributing
  • contributing:it
  • contributing:itb
  • contributing:itd
  • contributing:pr
  • contributing:prd
• Next steps
  • Running unit tests
  • Publishing your generator
• About
  • What is "Generate"?
  • Related projects
  • Community
  • Contributors
  • Contributing
  • Running tests
  • Author
  • License

(TOC generated byverb usingmarkdown-toc)

Installing the CLI

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

$ npm install --global generate

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

Install generate-contributing

Install this module with the following command:

$ npm install --global generate-contributing

Run this generator'sdefaulttask with the following command:

$ gen readme

What you should see in the terminal

If completed successfully, you should see bothstarting andfinished events in the terminal, like the following:

[00:44:21] starting ......[00:44:22] finished ✔

If you do not see one or both of those events, pleaselet us know about it.

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

$ genhelp

All available tasks for this generator.

Generate acontributing.md file.

Example

$ gen contributing$ gen contributing --dest ./docs

Generate anissue_template.md file to the.github/ directory, or specified--dest.

Example

$ gen contributing:it$ gen contributing:it --dest ./docs# also aliased as the following (mostly for API usage)$ gen contributing:issue_template

Generate a bare bonesissue_template.md file to the.github/ directory, or specified--dest. Usesthis template.

Example

$ gen contributing:itb$ gen contributing:itb --dest ./docs# also aliased as the following (mostly for API usage)$ gen contributing:issue_template_detailed

Generate a detailedissue_template.md file to the.github/ directory, or specified--dest. Usesthis template

Example

$ gen contributing:itd$ gen contributing:itd --dest ./docs# also aliased as the following (mostly for API usage)$ gen contributing:issue_template_detailed

Generate apull_request_template.md file to the.github/ directory, or specified--dest. Usesthis template.

Example

$ gen contributing:pr$ gen contributing:pr --dest ./docs# also aliased as the following (mostly for API usage)$ gen contributing:pr_template

Generate a detailedpull_request_template.md file to the.github/ directory, or specified--dest. Usesthis template.

Example

$ 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'sdocumentation for tasks.

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:

$ npm install&&test

If you're tests are passing and you're ready to publish your generator tonpm, you can do that now with the following command:

Are you sure you're ready?!

Let's go!

$ npm publish

Generate is a command line tool and developer framework for scaffolding out new GitHub projects usinggenerators andtasks.

Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support forgulp,base andassemble plugins, and much more.

For more information:

• Visit thegenerate project
• Visit thegenerate documentation
• Findgenerators on npm (help usauthor generators)

• generate-eslint: Generate a new.eslintrc.json or.eslintignore file from a pre-defined or user-defined template. Can be…more |homepage
• generate-license: Generate a license file. Choose any of the licenses supported byhttps://github.com/github/choosealicense.com. |homepage
• generate-project: Scaffold out complete code projects from the command line, or use this generator as a…more |homepage
• generate-travis: Generate a .travis.yml file to the cwd or specified directory. Install globally and run with…more |homepage

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 onStackOverflow with thegeneratejs tag
• Discuss Generate with us onGitter
• If you publish a generator, to make your project as discoverable as possible, please add the unique keywordgenerategenerator to your project's package.json.

Pull requests and stars are always welcome. For bugs and feature requests,please create an issue.

Please read thecontributing guide for advice on opening issues, pull requests, and coding standards.

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:

$ npm install&& npmtest

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

Copyright © 2018,Jon Schlinkert.Released under theMIT License.

This file was generated byverb-generate-readme, v0.6.0, on January 25, 2018.