Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/commonality/generator-community

䷤ Generate README, CODE_OF_CONDUCT, CONTRIBUTING, LICENSE, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE repository docs to encourage consumption and invite contributions.
https://github.com/commonality/generator-community
code-of-conduct code-of-conduct-template codeofconduct contributing contributing-template generator license readme readme-template recommended-community-standards yeoman-generator
Last synced: 3 months ago
JSON representation
䷤ Generate README, CODE_OF_CONDUCT, CONTRIBUTING, LICENSE, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE repository docs to encourage consumption and invite contributions.
Host: GitHub
URL: https://github.com/commonality/generator-community
Owner: commonality
License: mit
Created: 2017-09-01T02:51:54.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-04-30T02:55:43.000Z (8 months ago)
Last Synced: 2024-04-30T03:42:39.205Z (8 months ago)
Topics: code-of-conduct, code-of-conduct-template, codeofconduct, contributing, contributing-template, generator, license, readme, readme-template, recommended-community-standards, yeoman-generator
Language: JavaScript
Homepage:
Size: 2.82 MB
Stars: 8
Watchers: 6
Forks: 6
Open Issues: 42
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project

README

        # `generator-community`

[![License][license-badge-image]][license-url] [![Dependencies' licenses][fossa-badge-image]][fossa-url] [![NSP Status][nsp-badge-image]][nsp-url] [![Synk Vulnerabilities][snyk-vulnerabilities-badge-image]][snyk-vulnerabilities-url]
[![StackShare][stack-share-badge-image]][stack-share-url] [![Dependency Status][david-dm-badge-image]][daviddm-url] [![devDependencies Status][david-dm-dev-badge-image]][daviddm-dev-url] 
[![Build Status][travis-badge-image]][travis-url] [![Windows Build status][appveyor-badge-image]][appveyor-url] [![Coverage Status](https://coveralls.io/repos/github/commonality/generator-community/badge.svg?branch=master)](https://coveralls.io/github/commonality/generator-community?branch=master) [![Codacy quality][codacy-badge-image]][codacy-url]

> Generate `README`, `CODE_OF_CONDUCT`, `CONTRIBUTING`, and `LICENSE` files according to [recommended community standards][opensource-guide-community-standards-url].

## Table of contents

- [1. Overview](#1-overview)

- [2. Installation](#2-installation)

  * [2.1. Prerequisite software](#21-prerequisite-software)

  * [2.2. Install Yeoman and `generator-community`](#22-install-yeoman-and-generator-community)

- [3. Usage](#3-usage)

  * [3.1. `yo community:readme`](#31-yo-communityreadme)

    + [3.1.1. Guided assistance](#311-guided-assistance)

    + [3.1.2. CLI automation](#312-cli-automation)

  * [3.2. `yo community:conduct`](#32-yo-communityconduct)

    + [3.2.1. Guided assistance](#321-guided-assistance)

    + [3.2.2. CLI automation](#322-cli-automation)

  * [3.3. `yo community:contributing`](#33-yo-communitycontributing)

  * [3.4. `yo community:license`](#34-yo-communitylicense)

    + [3.4.1. Guided assistance](#341-guided-assistance)

    + [3.4.2. CLI automation](#342-cli-automation)

  * [3.5. Update tables of contents in markdown files](#35-update-tables-of-contents-in-markdown-files)

- [4. `npm-scripts`](#4-npm-scripts)

- [5. Semantic version and `CHANGELOG`](#5-semantic-version-and-changelog)

- [6. Contributing to `generator-community`](#6-contributing-to-generator-community)

- [7. License](#7-license)

## 1. Overview

`generator-community` helps product repository maintainers follow the [recommended community standards][opensource-guide-community-standards-url] for documentation that communicates expectations, manages contributions, protects participants' legal rights, and optimizes search engine results. `generator-community`'s simple command-line interface prompts you with simple questions in order to generate a:

1. `CODE_OF_CONDUCT.md`

2. `CONTRIBUTING.md`

3. Open source `LICENSE.md`

4. `README.md`

---

[![Alert icon][icon-alert-50-image]][milestones-url] Currently, `generator-community` generates a:

 1. `.editorconfig`

 1. `.gitattributes`

 1. `.gitignore`

 1. `.yo-rc.json` (to store answers for your convenience)

 1. `CODE_OF_CONDUCT.md`

 1. `LICENSE`

 1. `README.md`

`generator-community` also initializes local Git repository, if one doesn't yet exist.

Please [see the Milestones][milestones-url] for `generator-community's` release plan.

---

## 2. Installation

### 2.1. Prerequisite software

1. [Node.js][nodejs-url] v4.1.1 or greater

1. npm (which installs with Node.js)

1. [Yeoman][yeoman-url] (a command-line tool which you will install with npm, and not a manual download)

2. A `package.json` application manifest.

---

 Verify prerequisite software...





2.1.2. Verify Node.js availability

Open a Terminal and find out whether you have Node.js installed. Run:

$ node --version

# => v7.7.3



If you do not have [Node.js][nodejs-url] installed, you will receive an error message similar to:

# Linux or macOS

bash: foobar: command not found

# You need to install Node.js!







2.1.2. Install or update Node.js

You have two options for installing Node.js.

The easiest option is to simply download and install Node.js.

If you feel comfortable using the command line, try one of the following version managers:



  

Node Version Manager (nvm) (for macOS and Linux Bash shells)

  

nvm-windows (for Windows)

  

nodist (for Windows)








:information_source: I cannot vouch for the two Windows options, so do a little homework, first.







---

### 2.2. Install Yeoman and `generator-community`

Once you've verified that you have Node.js v4.1.1. or higher installed, open a Terminal and run these two commands:

```shell

# Install Yeoman and generator-community globally

$ npm install yo --global

# 💡 The letter "i" is shorthand for "install"; -g is short for --global

$ npm i generator-community -g

```

## 3. Usage

Install all four recommended community standards (README, CODE_OF_CONDUCT, CONTRIBUTING, and a LICENSE):

```shell

# Generate README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and LICENSE files

# per the recommended community community standards:

$ yo community

```

This will guide you with prompts to help you pre-fill the documents, e.g.,

```shell

$ yo community

? GitHub username or organization johndoe

? Product Name spike-repo

? Write a short description/value proposition The most valuable spike in the world....

? Product homepage URL https://example

? Author's name John Doe

? Author's e-mail [email protected]

? Author's homepage https://github.com/johndoe

? Package keywords (comma to split) recommended community standards,readme,license,toc,table of contents,markdown

? Which programming language does this product use the most? Node.js (JavaScript)

? What do you use to manage dependencies (e.g., Gradle, npm, NuGet)? Leave blank if you don't know. npm

? ⦾ 📄  LICENSE: Select a license MIT

? ⦾ 📄  CODE_OF_CONDUCT: Would you like to generate a Code of Conduct? Yes

? ⦾ 📄  README: Select the sections to include in your README Overview, Configuration, Security, API, Background, License

   create package.json

   create README.md

   create .editorconfig

   create .gitattributes

   create .gitignore

   create CODE_OF_CONDUCT.md

   create LICENSE

I'm all done. Running npm install for you to install the required dependencies. If this fails, try running the command yourself.

> [email protected] install /Users/swindle/Projects/github/commonality/sandbox/spike-repo/node_modules/commitplease

> node install

> [email protected] install /Users/swindle/Projects/github/commonality/sandbox/spike-repo/node_modules/nsp/node_modules/git-validate

> node bin/install

npm WARN prepublish-on-install As of npm@5, `prepublish` scripts are deprecated.

npm WARN prepublish-on-install Use `prepare` for build steps and `prepublishOnly` for upload-only.

npm WARN prepublish-on-install See the deprecation note in `npm help scripts` for more information.

> [email protected] prepublish /Users/swindle/Projects/github/commonality/sandbox/spike-repo

> nsp check

(+) No known vulnerabilities found

> [email protected] prepare /Users/swindle/Projects/github/commonality/sandbox/spike-repo

> npm run lint && npm run security

> [email protected] lint /Users/swindle/Projects/github/commonality/sandbox/spike-repo

> npm run lint:manifest

> [email protected] lint:manifest /Users/swindle/Projects/github/commonality/sandbox/spike-repo

> fixpack

missing main

package.json fixed!

> [email protected] security /Users/swindle/Projects/github/commonality/sandbox/spike-repo

> npm run security:nsp:scan

> [email protected] security:nsp:scan /Users/swindle/Projects/github/commonality/sandbox/spike-repo

> nsp check

(+) No known vulnerabilities found

npm notice created a lockfile as package-lock.json. You should commit this file.

added 571 packages in 9.146s

Thank you for generating community!

✔ /README.md Updated

 Transforms run

  ⁕ TOC:excludeText=Table of contents

```

### 3.1. `yo community:readme`

> ![Quote][icon-quote-left-image] READMEs do more than explain how to use your project. They also explain why your project matters, and what your users can do with it.

>

> In your README, try to answer the following questions:

>

> - What does this project do?

>

> - Why is this project useful?

>

> - How do I get started?

>

> - Where can I get more help, if I need it?

>

> Owen, K., Keepers, B., Shepherd, S., & Eghbal, N. (2017, February 17). Starting an Open Source Project. Retrieved September 13, 2017, from https://opensource.guide/starting-a-project/#writing-a-readme

#### 3.1.1. Guided assistance

To answer prompts manually, open a Terminal and run

```shell

$ yo community:readme

```

The `community:readme` subgenerator will evaluate your product repository's _manifests_ (e.g., package.json for Node.js products, or settings.gradle for Java products) to ensure consistency.

#### 3.1.2. CLI automation

You can automate README.md documentation via the command line interface (CLI) (e.g., during one of your CI/CD pipelines). To view all CLI options, use the `--help` or `-h` option:

```shell

$ yo community:readme -h

Usage:

  yo community:readme [options]

  Options:

    -h,   --help                # Print the generator's options and usage

          --skip-cache          # Do not remember prompt answers                    Default: false

          --skip-install        # Do not automatically install dependencies         Default: false

          --authorName          # Author name

          --authorUrl           # Author URL

          --dependencyManager   # Tool used to install third-party libraries        Default: Unspecified

          --generateInto        # Destination directory for generated files

          --gitRemoteOriginUrl  # The URI (SSH or HTTPS) of your Git repository     Default: /

          --githubAccount       # GitHub account/organization name

          --description         # Product description

          --lang                # Product's primary programming language            Default: Unspecified

          --license             # Open source software license

          --licenseUrl          # URL to your LICENSE file                          Default: ./LICENSE

          --name                # Product name

    -a,   --includeApi          # README.md: Public API overview (optional)         Default: true

    -b,   --includeBackground   # README.md: Background section content (optional)  Default: false

    -c,   --includeConfig       # README.md: Configuration instructions (optional)  Default: false

    -o,   --includeOverview     # README.md: Overview section content (optional)    Default: false

    -s,   --includeSecurity     # README.md: Security section content (optional)    Default: false

```

__Example:__

```shell

$ yo community:readme --authorName "Jane Doe" --authorUrl "https://jdoe.example.com" \

  --githubAccount janedoeasindeer --lang JavaScript --licenseName MIT \

  --name spike-sln-community \

  --description "A spike solution to test generator-community." \

  --includeApi --includeConfig --includeSecurity

```

### 3.2. `yo community:conduct`

> ![Quote][icon-quote-left-image] ...a code of conduct helps set ground rules for behavior for your project’s participants. This is especially valuable if you’re launching an open source project for a community or company. A code of conduct empowers you to facilitate healthy, constructive community behavior, which will reduce your stress as a maintainer.

>

> Owen, K., Keepers, B., Shepherd, S., & Eghbal, N. (2017, February 17). Starting an Open Source Project. Retrieved September 13, 2017, from https://opensource.guide/starting-a-project/#establishing-a-code-of-conduct

#### 3.2.1. Guided assistance

To answer prompts manually, open a Terminal and run

```shell

$ yo community:conduct

? Contact email: [email protected]

   create CODE_OF_CONDUCT.md

```

#### 3.2.2. CLI automation

You can automate CODE_OF_CONDUCT.md generation via the command line interface (CLI) (e.g., during one of your CI/CD pipelines). To view all CLI options, use the `--help` or `-h` option:

```shell

$ yo community:conduct --help

Usage:

  yo community:conduct [options]

Options:

  -h,   --help          # Print the generator's options and usage

        --skip-cache    # Do not remember prompt answers             Default: false

        --skip-install  # Do not automatically install dependencies  Default: false

        --email         # Contact email

        --generateInto  # Destination directory

```

__Example:__

```shell

$ yo community:conduct --email [email protected]

   create CODE_OF_CONDUCT.md

```

### 3.3. `yo community:contributing`

> ![Quote][icon-quote-left-image] A CONTRIBUTING file tells your audience how to participate in your project. For example, you might include information on:

>

> * How to file a bug report (try using issue and pull request templates)

> * How to suggest a new feature

> * How to set up your environment and run tests

>

> Owen, K., Keepers, B., Shepherd, S., & Eghbal, N. (2017, February 17). Starting an Open Source Project. Retrieved September 13, 2017, from https://opensource.guide/starting-a-project/#writing-your-contributing-guidelines

[![Alert icon][icon-goal-image]][milestones-url] This feature will be delivered with [MVP4: community:contribute][milestones-url].

### 3.4. `yo community:license`

> ![Quote][icon-quote-left-image] An open source license guarantees that others can use, copy, modify, and contribute back to your project without repercussions. It also protects you from sticky legal situations. **You must include a license when you launch an open source project.**

>

> Owen, K., Keepers, B., Shepherd, S., & Eghbal, N. (2017, February 17). Starting an Open Source Project. Retrieved September 13, 2017, from https://opensource.guide/starting-a-project/#launching-your-own-open-source-project

---

[![Alert icon][icon-alert-50-image]][milestones-url] If you already have a `LICENSE`, the `community:license` subgenerator will prompt you to overwrite it, as well as your `package.json`.

---

#### 3.4.1. Guided assistance

To answer prompts manually, open a Terminal and run

```shell

$ yo community:license

```

The `community:readme` subgenerator will evaluate your product repository's _manifests_ (e.g., package.json for Node.js products, or settings.gradle for Java products) to ensure consistency.

__Example:__

```shell

$ yo community:license

? What's your name: Greg Swindle

? Your email (optional): [email protected]

? Your website (optional):

? Which license do you want to use?

  Unlicense

  No License (Copyrighted)

  Apache 2.0

❯ MIT

  Mozilla Public License 2.0

  BSD 2-Clause (FreeBSD) License

  BSD 3-Clause (NewBSD) License

```

#### 3.4.2. CLI automation

You can automatically generate a LICENSE file via the command line interface (CLI) (e.g., during one of your CI/CD pipelines). To view all CLI options, use the `--help` or `-h` option:

```shell

yo community:license -h

Usage:

  yo community:license [options]

Options:

  -h,   --help            # Print the generator's options and usage

        --skip-cache      # Do not remember prompt answers                 Default: false

        --skip-install    # Do not automatically install dependencies      Default: false

        --defaultLicense  # Default license

        --email           # Email of the license owner

        --generateInto    # Destination directory of the generated files

        --license         # Enter an SPDX license name

        --name            # Name of the license owner

        --output          # Set the output file for the generated license  Default: LICENSE

        --website         # Website of the license owner

        --year            # Year(s) to include on the license              Default: 2017

```

### 3.5. Update tables of contents in markdown files

![Markdown icon][icon-markdown-image]

`yo community` installs an __npm-script__ that will help keep your documents' table of contents up-to-date. To automatically update your markdown files' tables of contents:

  * Add the following comments to your markdown file(s):

    ```md

    

    This text will be replaced by a table of contents 😏 .

    

    ```

  * Open a Terminal and run:

    ```shell

    $ npm run docs:toc

    ```

For more information, visit [`DavidWells/markdown-magic`][markdown-magic-toc-url].

## 4. `npm-scripts`

Software modules often have funky, irrelative names; therefore, we __prefix *custom* tasks__ by their responsibility and purpose.

| Prefix      | Definition                                                                            |

| ----------- | ------------------------------------------------------------------------------------- |

| `build*`    | Source code distribution tasks.                                                       |

| `docs*`     | API documentation and automation tasks.                                               |

| `lint*`     | Code style, standards, and vulnerabilty assessments (as well as fixes, if available). |

| `release`   | Bump the product's semver, update docs, commit, and publish to the `npm` registry.    |

| `security*` | Security vulnerabilty checks.                                                         |

The following CLI [`npm-scripts`][npm-scripts-docs-url] are available to you (assuming you're human, gentle reader) and CI-services.

| Script | Description |

|--------|-------------|

| `docs` | `npm run docs:scripts && npm run docs:toc` |

| `docs:toc` | `md-magic --path '**/*.md' --ignore 'node_modules'` |

| `lint` | `npm run lint:node-version && npm run lint:js && npm run lint:manifest` |

| `lint:js` | `eslint ./generators/**/*.js ./__tests__/**/*.js --fix` |

| `lint:manifest` | `fixpack` |

| `lint:node-version` | `check-node-version --package` |

| `prepublish` | `npm run security` |

| `release` | `standard-version` |

| `security` | `npm run security:nsp:scan` |

| `security:nsp:scan` | `nsp check` |

| `pretest` | `npm prune && npm run lint` |

| `test` | `jest --forceExit --config=jest.config.json` |

| `posttest` | `npm run security` |

## 5. Semantic version and `CHANGELOG`

The latest version of `commonality/generator-community` is `0.0.0`. View the [`CHANGELOG`][changelog-url] for details.

## 6. Contributing to `generator-community`

> [![Learn how to make a Pull Request with free training][prs-welcome-badge-image]][prs-welcome-url]

>

> We welcome contributors with [Pull Requests][prs-welcome-url]!

Contributions in the form of GitHub pull requests are welcome. Before embarking on a significant change, please adhere to the following guidelines:

  1. Read the [Code of Conduct][code-of-conduct-url].

  1. Create an issue to discuss the proposed change and ensure that it is likely to be merged:

      * [Report a defect][issues-new-defect-url] (aka "bug");

      * [Request a new feature][issues-new-feat-url];

      * [![Issue Status: Available][icon-issue-label-status-available-image] Volunteer for an available issue][issues-available-url].

  1. Follow [Contributing to `generator-community`][contributing-url]'s coding conventions and Git workflow if you're willing and able to program (or want to learn how).

## 7. License

[MIT][license-url] © [Greg Swindle][author-url].

__Third-party software licenses for `generator-community__ ([read the NOTICE file][notice-url] for a detailed report):

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fcommonality%2Fgenerator-community.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fcommonality%2Fgenerator-community?ref=badge_large)

---

[![Conventional Commits][conventional-commits-badge-image]][conventional-commits-url] [![Greenkeeper automated dependency management][greenkeeper-badge-image]][greenkeeper-url] [![README score][readme-score-badge-image]][readme-score-url]

[angularjs-commit-message-guidelines-url]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit

[appveyor-badge-image]: https://ci.appveyor.com/api/projects/status/66fxlb567335cidt?svg=true

[appveyor-url]: https://ci.appveyor.com/project/gregswindle/generator-community

[author-url]: https://github.com/commonality

[changelog-url]: ./CHANGELOG.md

[cla-url]: https://www.clahub.com/agreements/commonality/generator-community

[codacy-badge-image]: https://img.shields.io/codacy/grade/de7b30825ac649de8b7255e4303fb069.svg?style=flat-square

[codacy-url]: https://www.codacy.com/app/commonality/generator-community?utm_source=github.com&utm_medium=referral&utm_content=commonality/generator-community&utm_campaign=Badge_Grade

[code-of-conduct-url]: ./.github/CODE_OF_CONDUCT.md

[code-of-conduct-url]: ./CODE_OF_CONDUCT.md

[complexity-report-url]: ./docs/COMPLEXITY.md

[contributing-url]: ./.github/CONTRIBUTING.md

[contributing-url]: ./CONTRIBUTING.md

[conventional-changelog-url]: https://github.com/conventional-changelog/conventional-changelog

[conventional-commits-badge-image]: https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg?style=flat-square

[conventional-commits-url]: https://conventionalcommits.org/

[coolor-palette-url]: https://coolors.co/cfdbd5-e8eddf-f5cb5c-242423-333533

[coveralls-badge-image]: https://img.shields.io/coveralls/repos/commonality/generator-community/badge.svg?branch=master&style=flat-square

[coveralls-url]: https://coveralls.io/r/commonality/generator-community

[david-dm-badge-image]: https://img.shields.io/david/dev/commonality/generator-community.svg?style=flat-square

[david-dm-dev-badge-image]: https://img.shields.io/david/commonality/generator-community.svg?style=flat-square

[daviddm-dev-url]: https://david-dm.org/commonality/generator-community?type=dev

[daviddm-url]: https://david-dm.org/commonality/generator-community

[fossa-badge-image]: https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fcommonality%2Fgenerator-community.svg?type=shield

[fossa-url]: https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fcommonality%2Fgenerator-community?ref=badge_shield

[generator-community-color-palette-image]: ./docs/style-guide/generator-community-color-palette.png

[generator-community-color-palette-pdf-url]: ./docs/style-guide/generator-community-color-palette.pdf

[generator-community-color-palette-png-url]: ./docs/style-guide/generator-community-color-palette.png

[generator-community-color-palette-scss-url]: ./docs/style-guide/generator-community-color-palette.scss

[generator-community-logo-image]: ./docs/img/logo-commonalaxy.png

[generator-community-repo-url]: ./README.md

[gh-standardjs-url]: https://github.com/feross/standard

[git-workflow-feature-branch-tutorial-url]: https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow

[greenkeeper-badge-image]: https://badges.greenkeeper.io/commonality/generator-community.svg?style=flat-square

[greenkeeper-url]: https://greenkeeper.io/

[icon-alert-50-image]: ./docs/img/icons8/icon-alert-50.png

[icon-eslint-image]: ./docs/img/tech-stack/icon-eslint-50.jpeg

[icon-goal-image]: ./docs/img/icons8/icon-goal.png

[icon-help-image]: ./docs/img/icons8/icon-help-48.png

[icon-issue-label-status-available-image]: ./docs/img/icon-issue-label-status-available.png

[icon-jest-image]: ./docs/img/tech-stack/icon-jest-50.jpeg

[icon-markdown-image]: ./docs/img/icons8/icon-markdown.png

[icon-nodejs-image]: ./docs/img/tech-stack/icon-nodejs-50.png

[icon-npm-image]: ./docs/img/tech-stack/icon-npm-50.png

[icon-package-image]: ./docs/img/icons8/icon-package-filled.png

[icon-quote-left-image]: ./docs/img/icons8/icon-quote-left-25.png

[icon-road-milestone-image]: ./docs/img/icons8/img-goal-filled-50.png

[icon-standardjs-image]: ./docs/img/tech-stack/icon-standardjs-50.png

[icon-travis-image]: ./docs/img/icons8/travis-ci-50.png

[icon-user-manual-image]: ./docs/img/icons8/icon-user-manual-grey-50.png

[icon-yeoman-image]: ./docs/img/tech-stack/icon-yeoman-50.png

[icons8-license-url]: https://icons8.com/license/

[issues-available-url]: /commonality/generator-community/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+Available%22

[issues-new-defect-url]: https://github.com/commonality/generator-community/issues/new?title=fix%28affected-scope%29%3A+subject-line-with-very-few-words&labels=Priority%3A+Medium%2CStatus%3A+Review+Needed%2CType%3A+Defect&body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+__Feature%3A__+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+__EXAMPLE%3A__%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+__behavior+you+expect__+to+see%2C+or+the+behavior+that+__would__+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A

[issues-new-feat-url]: https://github.com/commonality/generator-community/issues/new?title=feat%28affected-scope%29%3A+subject-line-with-very-few-words&labels=Priority%3A+Medium%2CStatus%3A+Review+Needed%2CType%3A+Feature&body=%2A%2A%F0%9F%92%A1+TIP%3A%2A%2A+Select+the+%E2%86%96%EF%B8%8E%E2%8E%BE+Preview+%E2%8F%8B+Tab+above+help+read+these+instructions.%0D%0A%0D%0A%23%23+1.+Issue+type%0D%0A%3E%E2%8C%A6+Type+the+letter+%22x%22+in+the+%22checkbox%22+the+best+describe+this+issue.%0D%0A%0D%0A-+%5Bx%5D+__Feature%3A__+I%27m+requesting+a+product+enhancement.%0D%0A%0D%0A%23%23+2.+User+story+summary%0D%0A%3E%E2%8C%A6+Describe+what+you+want+to+accomplish%2C+in+what+role%2Fcapacity%2C+and+why+it%27s+important+to+you.%0D%0A%0D%0A%3E+__EXAMPLE%3A__%0D%0A%3E+As+a+Applicant%2C%0D%0A%3E+I+want+to+submit+my+resume%0D%0A%3E+In+order+to+be+considered+for+a+job+opening.%0D%0A%0D%0AAs+a+%7Brole%7D%2C%0D%0AI+must%2Fneed%2Fwant%2Fshould+%7Bdo+something%7D%0D%0AIn+order+to+%7Bachieve+value%7D.%0D%0A%0D%0A%23%23+3.+Acceptance+criteria%0D%0A%3E%E2%8C%A6+Replace+the+examples+below+with+your+own+imperative%2C+%22true%2Ffalse%22+statements+for+the+__behavior+you+expect__+to+see%2C+or+the+behavior+that+__would__+be+true+if+there+were+no+errors+%28for+defects%29.%0D%0A%0D%0A-+%5B+%5D+1.+Job+Applicants+receive+a+confirmation+email+after+they+submit+their+resumes.%0D%0A-+%5B+%5D+2.+An+Applicant%27s+resume+information+isn%27t+lost+when+errors+occur.%0D%0A-+%5B+%5D+3.+%7Bcriterion-three%7D%0D%0A-+%5B+%5D+4.+%7Bcriterion-four%7D%0D%0A%0D%0A%3C%21--+%E2%9B%94%EF%B8%8F++Do+not+remove+anything+below+this+comment.+%E2%9B%94%EF%B8%8F++--%3E%0D%0A%5Bicon-info-image%5D%3A+..%2Fdocs%2Fimg%2Ficons8%2Ficon-info-50.png%0D%0A

[license-badge-image]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square

[license-choose-url]: https://choosealicense.com/

[license-no-license-url]: https://choosealicense.com/no-license/

[license-unlicense-url]: https://choosealicense.com/licenses/#unlicense

[license-url]: ./LICENSE

[markdown-magic-toc-url]: https://github.com/DavidWells/markdown-magic#-toc

[milestones-url]: https://github.com/commonality/generator-community/milestones

[nodejs-url]: https://nodejs.org

[notice-url]: ./NOTICE.md

[npm-badge-image]: https://img.shields.io/npm/v/generator-community.svg?style=flat-square

[npm-scripts-docs-url]: https://docs.npmjs.com/misc/scripts

[npm-url]: https://npmjs.org/package/generator-community

[npmjs-url]: https://www.npmjs.com/

[nsp-badge-image]: https://nodesecurity.io/orgs/commonality/projects/0662674a-ad9f-4b2f-a930-30615e6222cd/badge?style=flat-square

[nsp-sign-up-url]: https://nodesecurity.io/signup

[nsp-url]: https://nodesecurity.io/orgs/commonality/projects/0662674a-ad9f-4b2f-a930-30615e6222cd

[nvm-url]: https://github.com/creationix/nvm

[opensource-guide-community-standards-url]: https://opensource.guide

[pr-url]: /commonality/generator-community/pulls

[prs-welcome-badge-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square

[prs-welcome-url]: http://makeapullrequest.com

[quote-left-img]: ./docs/img/icons8/quote-left-25.png

[readme-score-badge-image]: http://readme-score-api.herokuapp.com/score.svg?style=flat-square&url=https://github.com/commonality/generator-community

[readme-score-url]: http://clayallsopp.github.io/readme-score?url=https://github.com/commonality/generator-community

[snyk-vulnerabilities-badge-image]: https://snyk.io/test/github/commonality/generator-community/badge.svg?style=flat-square

[snyk-vulnerabilities-url]: https://snyk.io/test/github/commonality/generator-community

[sonarcloud-url]: https://sonarcloud.io

[stack-share-badge-image]: https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat-square

[stack-share-news-feed-image]: ./docs/img/tech-stack/icon-news-feed-50.png

[stack-share-news-feed-url]: https://stackshare.io/news/filter/75847/1724/save

[stack-share-rss-feed-image]: ./docs/img/tech-stack/icon-rss-feed-50.png

[stack-share-rss-feed-url]: https://stackshare.io/news/75847/1724/feed

[stack-share-url]: https://stackshare.io/commonality/generator-community

[standard-version-cut-a-release-url]: https://github.com/conventional-changelog/standard-version#cut-a-release

[standardjs-badge-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square

[standardjs-url]: https://standardjs.com/

[travis-badge-image]: https://img.shields.io/travis/commonality/generator-community.svg?branch=master&style=flat-square

[travis-url]: https://travis-ci.org/commonality/generator-community

[yeoman-url]: https://yeoman.io