{"id":15511661,"url":"https://github.com/commonality/generator-community","last_synced_at":"2025-05-07T05:10:18.091Z","repository":{"id":24788355,"uuid":"102067020","full_name":"commonality/generator-community","owner":"commonality","description":"䷤ Generate README, CODE_OF_CONDUCT, CONTRIBUTING, LICENSE, ISSUE_TEMPLATE, and PULL_REQUEST_TEMPLATE repository docs to encourage consumption and invite contributions.","archived":false,"fork":false,"pushed_at":"2024-11-12T06:27:22.000Z","size":3983,"stargazers_count":9,"open_issues_count":47,"forks_count":7,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-31T06:41:18.416Z","etag":null,"topics":["code-of-conduct","code-of-conduct-template","codeofconduct","contributing","contributing-template","generator","license","readme","readme-template","recommended-community-standards","yeoman-generator"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/commonality.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-01T02:51:54.000Z","updated_at":"2024-07-21T00:30:39.000Z","dependencies_parsed_at":"2024-04-16T05:29:20.758Z","dependency_job_id":"da0569d4-b52d-43fe-802f-11d27e6fa850","html_url":"https://github.com/commonality/generator-community","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fgenerator-community","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fgenerator-community/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fgenerator-community/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/commonality%2Fgenerator-community/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/commonality","download_url":"https://codeload.github.com/commonality/generator-community/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252817630,"owners_count":21808706,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["code-of-conduct","code-of-conduct-template","codeofconduct","contributing","contributing-template","generator","license","readme","readme-template","recommended-community-standards","yeoman-generator"],"created_at":"2024-10-02T09:53:10.000Z","updated_at":"2025-05-07T05:10:18.072Z","avatar_url":"https://github.com/commonality.png","language":"JavaScript","readme":"# `generator-community`\n\n[![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]\u003cbr\u003e[![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] \u003cbr\u003e[![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]\n\u003e Generate `README`, `CODE_OF_CONDUCT`, `CONTRIBUTING`, and `LICENSE` files according to [recommended community standards][opensource-guide-community-standards-url].\n\n\n\n## Table of contents\n\u003c!-- ⛔️ AUTO-GENERATED-CONTENT:START (TOC:excludeText=Table of contents) --\u003e\n- [1. Overview](#1-overview)\n- [2. Installation](#2-installation)\n  * [2.1. Prerequisite software](#21-prerequisite-software)\n  * [2.2. Install Yeoman and `generator-community`](#22-install-yeoman-and-generator-community)\n- [3. Usage](#3-usage)\n  * [3.1. `yo community:readme`](#31-yo-communityreadme)\n    + [3.1.1. Guided assistance](#311-guided-assistance)\n    + [3.1.2. CLI automation](#312-cli-automation)\n  * [3.2. `yo community:conduct`](#32-yo-communityconduct)\n    + [3.2.1. Guided assistance](#321-guided-assistance)\n    + [3.2.2. CLI automation](#322-cli-automation)\n  * [3.3. `yo community:contributing`](#33-yo-communitycontributing)\n  * [3.4. `yo community:license`](#34-yo-communitylicense)\n    + [3.4.1. Guided assistance](#341-guided-assistance)\n    + [3.4.2. CLI automation](#342-cli-automation)\n  * [3.5. Update tables of contents in markdown files](#35-update-tables-of-contents-in-markdown-files)\n- [4. `npm-scripts`](#4-npm-scripts)\n- [5. Semantic version and `CHANGELOG`](#5-semantic-version-and-changelog)\n- [6. Contributing to `generator-community`](#6-contributing-to-generator-community)\n- [7. License](#7-license)\n\u003c!-- ⛔️ AUTO-GENERATED-CONTENT:END --\u003e\n\n## 1. Overview\n\n`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:\n\n1. `CODE_OF_CONDUCT.md`\n2. `CONTRIBUTING.md`\n3. Open source `LICENSE.md`\n4. `README.md`\n\n---\n\n[![Alert icon][icon-alert-50-image]][milestones-url] Currently, `generator-community` generates a:\n\n 1. `.editorconfig`\n 1. `.gitattributes`\n 1. `.gitignore`\n 1. `.yo-rc.json` (to store answers for your convenience)\n 1. `CODE_OF_CONDUCT.md`\n 1. `LICENSE`\n 1. `README.md`\n\n`generator-community` also initializes local Git repository, if one doesn't yet exist.\n\nPlease [see the Milestones][milestones-url] for `generator-community's` release plan.\n\n---\n\n## 2. Installation\n\n### 2.1. Prerequisite software\n\n1. [Node.js][nodejs-url] v4.1.1 or greater\n1. npm (which installs with Node.js)\n1. [Yeoman][yeoman-url] (a command-line tool which you will install with npm, and not a manual download)\n2. A `package.json` application manifest.\n\n---\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cimg src=\"./docs/img/icons8/icon-help-48.png\" alt=\"Help\" align=\"middle\" height=\"48\" width=\"48\"\u003e \u003cstrong\u003eVerify prerequisite software...\u003c/strong\u003e\u003c/summary\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ch4\u003e2.1.2. Verify Node.js availability\u003c/h4\u003e\n\u003cp\u003eOpen a Terminal and find out whether you have Node.js installed. Run:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"language-bash\"\u003e$ node --version\n\u003cspan class=\"hljs-comment\"\u003e# =\u0026gt; v7.7.3\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf you do not have [Node.js][nodejs-url] installed, you will receive an error message similar to:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class=\"language-bash\"\u003e\u003cspan class=\"hljs-comment\"\u003e# Linux or macOS\u003c/span\u003e\nbash: foobar: \u003cspan class=\"hljs-built_in\"\u003ecommand\u003c/span\u003e not found\n\u003cspan class=\"hljs-comment\"\u003e# You need to install Node.js!\u003c/span\u003e\n\u003c/code\u003e\u003c/pre\u003e\u003c/li\u003e\n\u003cli\u003e\u003ch4\u003e2.1.2. Install or update Node.js\u003c/h4\u003e\n\u003cp\u003eYou have two options for installing Node.js.\u003c/p\u003e\n\u003cp\u003eThe easiest option is to simply \u003ca href=\"https://nodejs.org\"\u003edownload and install Node.js\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIf you feel comfortable using the command line, try one of the following version managers:\u003c/p\u003e\n\u003cul\u003e\n  \u003cli\u003e\u003ca href=\"https://github.com/creationix/nvm\"\u003eNode Version Manager (\u003ccode\u003envm\u003c/code\u003e)\u003c/a\u003e (for macOS and Linux Bash shells)\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"https://github.com/coreybutler/nvm-windows\"\u003envm-windows\u003c/a\u003e (for Windows)\u003c/li\u003e\n  \u003cli\u003e\u003ca href=\"https://github.com/marcelklehr/nodist\"\u003enodist\u003c/a\u003e (for Windows)\u003c/li\u003e\n\u003c/ul\u003e\n\u003cbr\u003e\n\u003cblockquote\u003e\n\u003cp\u003e:information_source: I cannot vouch for the two Windows options, so do a little homework, first.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003c/ul\u003e\n\u003c/details\u003e\n\n---\n\n### 2.2. Install Yeoman and `generator-community`\n\nOnce you've verified that you have Node.js v4.1.1. or higher installed, open a Terminal and run these two commands:\n\n```shell\n# Install Yeoman and generator-community globally\n$ npm install yo --global\n\n# 💡 The letter \"i\" is shorthand for \"install\"; -g is short for --global\n$ npm i generator-community -g\n```\n\n## 3. Usage\n\nInstall all four recommended community standards (README, CODE_OF_CONDUCT, CONTRIBUTING, and a LICENSE):\n\n```shell\n# Generate README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and LICENSE files\n# per the recommended community community standards:\n\n$ yo community\n```\n\nThis will guide you with prompts to help you pre-fill the documents, e.g.,\n\n```shell\n$ yo community\n? GitHub username or organization johndoe\n? Product Name spike-repo\n? Write a short description/value proposition The most valuable spike in the world....\n? Product homepage URL https://example\n? Author's name John Doe\n? Author's e-mail john@doe.info\n? Author's homepage https://github.com/johndoe\n? Package keywords (comma to split) recommended community standards,readme,license,toc,table of contents,markdown\n? Which programming language does this product use the most? Node.js (JavaScript)\n? What do you use to manage dependencies (e.g., Gradle, npm, NuGet)? Leave blank if you don't know. npm\n? ⦾ 📄  LICENSE: Select a license MIT\n? ⦾ 📄  CODE_OF_CONDUCT: Would you like to generate a Code of Conduct? Yes\n? ⦾ 📄  README: Select the sections to include in your README Overview, Configuration, Security, API, Background, License\n   create package.json\n   create README.md\n   create .editorconfig\n   create .gitattributes\n   create .gitignore\n   create CODE_OF_CONDUCT.md\n   create LICENSE\n\n\nI'm all done. Running npm install for you to install the required dependencies. If this fails, try running the command yourself.\n\n\n\n\u003e commitplease@2.7.10 install /Users/swindle/Projects/github/commonality/sandbox/spike-repo/node_modules/commitplease\n\u003e node install\n\n\n\u003e git-validate@2.2.2 install /Users/swindle/Projects/github/commonality/sandbox/spike-repo/node_modules/nsp/node_modules/git-validate\n\u003e node bin/install\n\nnpm WARN prepublish-on-install As of npm@5, `prepublish` scripts are deprecated.\nnpm WARN prepublish-on-install Use `prepare` for build steps and `prepublishOnly` for upload-only.\nnpm WARN prepublish-on-install See the deprecation note in `npm help scripts` for more information.\n\n\u003e spike-repo@0.0.0 prepublish /Users/swindle/Projects/github/commonality/sandbox/spike-repo\n\u003e nsp check\n\n(+) No known vulnerabilities found\n\n\u003e spike-repo@0.0.0 prepare /Users/swindle/Projects/github/commonality/sandbox/spike-repo\n\u003e npm run lint \u0026\u0026 npm run security\n\n\n\u003e spike-repo@0.0.0 lint /Users/swindle/Projects/github/commonality/sandbox/spike-repo\n\u003e npm run lint:manifest\n\n\n\u003e spike-repo@0.0.0 lint:manifest /Users/swindle/Projects/github/commonality/sandbox/spike-repo\n\u003e fixpack\n\nmissing main\npackage.json fixed!\n\n\u003e spike-repo@0.0.0 security /Users/swindle/Projects/github/commonality/sandbox/spike-repo\n\u003e npm run security:nsp:scan\n\n\n\u003e spike-repo@0.0.0 security:nsp:scan /Users/swindle/Projects/github/commonality/sandbox/spike-repo\n\u003e nsp check\n\n(+) No known vulnerabilities found\nnpm notice created a lockfile as package-lock.json. You should commit this file.\nadded 571 packages in 9.146s\nThank you for generating community!\n✔ /README.md Updated\n Transforms run\n  ⁕ TOC:excludeText=Table of contents\n```\n\n### 3.1. `yo community:readme`\n\u003e ![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.\n\u003e\n\u003e In your README, try to answer the following questions:\n\u003e\n\u003e - What does this project do?\n\u003e\n\u003e - Why is this project useful?\n\u003e\n\u003e - How do I get started?\n\u003e\n\u003e - Where can I get more help, if I need it?\n\u003e\n\u003e Owen, K., Keepers, B., Shepherd, S., \u0026 Eghbal, N. (2017, February 17). Starting an Open Source Project. Retrieved September 13, 2017, from https://opensource.guide/starting-a-project/#writing-a-readme\n\n#### 3.1.1. Guided assistance\n\nTo answer prompts manually, open a Terminal and run\n\n```shell\n$ yo community:readme\n```\n\nThe `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.\n\n#### 3.1.2. CLI automation\n\nYou 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:\n\n```shell\n$ yo community:readme -h\nUsage:\n  yo community:readme [options]\n\n  Options:\n    -h,   --help                # Print the generator's options and usage\n          --skip-cache          # Do not remember prompt answers                    Default: false\n          --skip-install        # Do not automatically install dependencies         Default: false\n          --authorName          # Author name\n          --authorUrl           # Author URL\n          --dependencyManager   # Tool used to install third-party libraries        Default: Unspecified\n          --generateInto        # Destination directory for generated files\n          --gitRemoteOriginUrl  # The URI (SSH or HTTPS) of your Git repository     Default: /\n          --githubAccount       # GitHub account/organization name\n          --description         # Product description\n          --lang                # Product's primary programming language            Default: Unspecified\n          --license             # Open source software license\n          --licenseUrl          # URL to your LICENSE file                          Default: ./LICENSE\n          --name                # Product name\n    -a,   --includeApi          # README.md: Public API overview (optional)         Default: true\n    -b,   --includeBackground   # README.md: Background section content (optional)  Default: false\n    -c,   --includeConfig       # README.md: Configuration instructions (optional)  Default: false\n    -o,   --includeOverview     # README.md: Overview section content (optional)    Default: false\n    -s,   --includeSecurity     # README.md: Security section content (optional)    Default: false\n```\n\n__Example:__\n\n```shell\n$ yo community:readme --authorName \"Jane Doe\" --authorUrl \"https://jdoe.example.com\" \\\n  --githubAccount janedoeasindeer --lang JavaScript --licenseName MIT \\\n  --name spike-sln-community \\\n  --description \"A spike solution to test generator-community.\" \\\n  --includeApi --includeConfig --includeSecurity\n```\n\n### 3.2. `yo community:conduct`\n\u003e ![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.\n\u003e\n\u003e Owen, K., Keepers, B., Shepherd, S., \u0026 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\n\n#### 3.2.1. Guided assistance\n\nTo answer prompts manually, open a Terminal and run\n\n```shell\n$ yo community:conduct\n? Contact email: fake@elsewhere.net\n   create CODE_OF_CONDUCT.md\n```\n\n#### 3.2.2. CLI automation\n\nYou 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:\n\n```shell\n$ yo community:conduct --help\nUsage:\n  yo community:conduct [options]\n\nOptions:\n  -h,   --help          # Print the generator's options and usage\n        --skip-cache    # Do not remember prompt answers             Default: false\n        --skip-install  # Do not automatically install dependencies  Default: false\n        --email         # Contact email\n        --generateInto  # Destination directory\n```\n\n__Example:__\n\n```shell\n$ yo community:conduct --email somebody@example.com\n   create CODE_OF_CONDUCT.md\n```\n\n### 3.3. `yo community:contributing`\n\u003e ![Quote][icon-quote-left-image] A CONTRIBUTING file tells your audience how to participate in your project. For example, you might include information on:\n\u003e\n\u003e * How to file a bug report (try using issue and pull request templates)\n\u003e * How to suggest a new feature\n\u003e * How to set up your environment and run tests\n\u003e\n\u003e Owen, K., Keepers, B., Shepherd, S., \u0026 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\n\n[![Alert icon][icon-goal-image]][milestones-url] This feature will be delivered with [MVP4: community:contribute][milestones-url].\n\n### 3.4. `yo community:license`\n\u003e ![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.**\n\u003e\n\u003e Owen, K., Keepers, B., Shepherd, S., \u0026 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\n\n---\n\n[![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`.\n\n---\n\n#### 3.4.1. Guided assistance\n\nTo answer prompts manually, open a Terminal and run\n\n```shell\n$ yo community:license\n```\n\nThe `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.\n\n__Example:__\n\n```shell\n$ yo community:license\n? What's your name: Greg Swindle\n? Your email (optional): greg@swindle.net\n? Your website (optional):\n? Which license do you want to use?\n  Unlicense\n  No License (Copyrighted)\n  Apache 2.0\n❯ MIT\n  Mozilla Public License 2.0\n  BSD 2-Clause (FreeBSD) License\n  BSD 3-Clause (NewBSD) License\n```\n\n#### 3.4.2. CLI automation\n\nYou 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:\n\n```shell\nyo community:license -h\nUsage:\n  yo community:license [options]\n\nOptions:\n  -h,   --help            # Print the generator's options and usage\n        --skip-cache      # Do not remember prompt answers                 Default: false\n        --skip-install    # Do not automatically install dependencies      Default: false\n        --defaultLicense  # Default license\n        --email           # Email of the license owner\n        --generateInto    # Destination directory of the generated files\n        --license         # Enter an SPDX license name\n        --name            # Name of the license owner\n        --output          # Set the output file for the generated license  Default: LICENSE\n        --website         # Website of the license owner\n        --year            # Year(s) to include on the license              Default: 2017\n```\n\n### 3.5. Update tables of contents in markdown files\n\n![Markdown icon][icon-markdown-image]\n\n`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:\n\n  * Add the following comments to your markdown file(s):\n    ```md\n    \u003c!-- ⛔️ AUTO-GENERATED-CONTENT:START (TOC:excludeText=Table of contents) --\u003e\n    This text will be replaced by a table of contents 😏 .\n    \u003c!-- ⛔️ AUTO-GENERATED-CONTENT:END --\u003e\n    ```\n  * Open a Terminal and run:\n    ```shell\n    $ npm run docs:toc\n    ```\n\nFor more information, visit [`DavidWells/markdown-magic`][markdown-magic-toc-url].\n\n## 4. `npm-scripts`\n\nSoftware modules often have funky, irrelative names; therefore, we __prefix *custom* tasks__ by their responsibility and purpose.\n\n| Prefix      | Definition                                                                            |\n| ----------- | ------------------------------------------------------------------------------------- |\n| `build*`    | Source code distribution tasks.                                                       |\n| `docs*`     | API documentation and automation tasks.                                               |\n| `lint*`     | Code style, standards, and vulnerabilty assessments (as well as fixes, if available). |\n| `release`   | Bump the product's semver, update docs, commit, and publish to the `npm` registry.    |\n| `security*` | Security vulnerabilty checks.                                                         |\n\nThe following CLI [`npm-scripts`][npm-scripts-docs-url] are available to you (assuming you're human, gentle reader) and CI-services.\n\n\u003c!-- AUTO-GENERATED-CONTENT:START (SCRIPTS) --\u003e\n| Script | Description |\n|--------|-------------|\n| `docs` | `npm run docs:scripts \u0026\u0026 npm run docs:toc` |\n| `docs:toc` | `md-magic --path '**/*.md' --ignore 'node_modules'` |\n| `lint` | `npm run lint:node-version \u0026\u0026 npm run lint:js \u0026\u0026 npm run lint:manifest` |\n| `lint:js` | `eslint ./generators/**/*.js ./__tests__/**/*.js --fix` |\n| `lint:manifest` | `fixpack` |\n| `lint:node-version` | `check-node-version --package` |\n| `prepublish` | `npm run security` |\n| `release` | `standard-version` |\n| `security` | `npm run security:nsp:scan` |\n| `security:nsp:scan` | `nsp check` |\n| `pretest` | `npm prune \u0026\u0026 npm run lint` |\n| `test` | `jest --forceExit --config=jest.config.json` |\n| `posttest` | `npm run security` |\n\u003c!-- AUTO-GENERATED-CONTENT:END --\u003e\n\n## 5. Semantic version and `CHANGELOG`\n\nThe latest version of `commonality/generator-community` is `0.0.0`. View the [`CHANGELOG`][changelog-url] for details.\n\n## 6. Contributing to `generator-community`\n\u003e [![Learn how to make a Pull Request with free training][prs-welcome-badge-image]][prs-welcome-url]\n\u003e\n\u003e We welcome contributors with [Pull Requests][prs-welcome-url]!\n\nContributions in the form of GitHub pull requests are welcome. Before embarking on a significant change, please adhere to the following guidelines:\n\n  1. Read the [Code of Conduct][code-of-conduct-url].\n  1. Create an issue to discuss the proposed change and ensure that it is likely to be merged:\n      * [Report a defect][issues-new-defect-url] (aka \"bug\");\n      * [Request a new feature][issues-new-feat-url];\n      * [![Issue Status: Available][icon-issue-label-status-available-image] Volunteer for an available issue][issues-available-url].\n  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).\n\n## 7. License\n\n[MIT][license-url] © [Greg Swindle][author-url].\n\n__Third-party software licenses for `generator-community__ ([read the NOTICE file][notice-url] for a detailed report):\n\n[![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)\n\n---\n\n[![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]\n\n\n\u003c!-- ⛔️ 📝 NOTE: PLEASE ALPHABETIZE LINK REFERENCES. 📝 ⛔️ --\u003e\n\n[angularjs-commit-message-guidelines-url]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit\n[appveyor-badge-image]: https://ci.appveyor.com/api/projects/status/66fxlb567335cidt?svg=true\n[appveyor-url]: https://ci.appveyor.com/project/gregswindle/generator-community\n[author-url]: https://github.com/commonality\n[changelog-url]: ./CHANGELOG.md\n[cla-url]: https://www.clahub.com/agreements/commonality/generator-community\n[codacy-badge-image]: https://img.shields.io/codacy/grade/de7b30825ac649de8b7255e4303fb069.svg?style=flat-square\n[codacy-url]: https://www.codacy.com/app/commonality/generator-community?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=commonality/generator-community\u0026amp;utm_campaign=Badge_Grade\n[code-of-conduct-url]: ./.github/CODE_OF_CONDUCT.md\n[code-of-conduct-url]: ./CODE_OF_CONDUCT.md\n[complexity-report-url]: ./docs/COMPLEXITY.md\n[contributing-url]: ./.github/CONTRIBUTING.md\n[contributing-url]: ./CONTRIBUTING.md\n[conventional-changelog-url]: https://github.com/conventional-changelog/conventional-changelog\n[conventional-commits-badge-image]: https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg?style=flat-square\n[conventional-commits-url]: https://conventionalcommits.org/\n[coolor-palette-url]: https://coolors.co/cfdbd5-e8eddf-f5cb5c-242423-333533\n[coveralls-badge-image]: https://img.shields.io/coveralls/repos/commonality/generator-community/badge.svg?branch=master\u0026style=flat-square\n[coveralls-url]: https://coveralls.io/r/commonality/generator-community\n[david-dm-badge-image]: https://img.shields.io/david/dev/commonality/generator-community.svg?style=flat-square\n[david-dm-dev-badge-image]: https://img.shields.io/david/commonality/generator-community.svg?style=flat-square\n[daviddm-dev-url]: https://david-dm.org/commonality/generator-community?type=dev\n[daviddm-url]: https://david-dm.org/commonality/generator-community\n[fossa-badge-image]: https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fcommonality%2Fgenerator-community.svg?type=shield\n[fossa-url]: https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fcommonality%2Fgenerator-community?ref=badge_shield\n[generator-community-color-palette-image]: ./docs/style-guide/generator-community-color-palette.png\n[generator-community-color-palette-pdf-url]: ./docs/style-guide/generator-community-color-palette.pdf\n[generator-community-color-palette-png-url]: ./docs/style-guide/generator-community-color-palette.png\n[generator-community-color-palette-scss-url]: ./docs/style-guide/generator-community-color-palette.scss\n[generator-community-logo-image]: ./docs/img/logo-commonalaxy.png\n[generator-community-repo-url]: ./README.md\n[gh-standardjs-url]: https://github.com/feross/standard\n[git-workflow-feature-branch-tutorial-url]: https://www.atlassian.com/git/tutorials/comparing-workflows#feature-branch-workflow\n[greenkeeper-badge-image]: https://badges.greenkeeper.io/commonality/generator-community.svg?style=flat-square\n[greenkeeper-url]: https://greenkeeper.io/\n[icon-alert-50-image]: ./docs/img/icons8/icon-alert-50.png\n[icon-eslint-image]: ./docs/img/tech-stack/icon-eslint-50.jpeg\n[icon-goal-image]: ./docs/img/icons8/icon-goal.png\n[icon-help-image]: ./docs/img/icons8/icon-help-48.png\n[icon-issue-label-status-available-image]: ./docs/img/icon-issue-label-status-available.png\n[icon-jest-image]: ./docs/img/tech-stack/icon-jest-50.jpeg\n[icon-markdown-image]: ./docs/img/icons8/icon-markdown.png\n[icon-nodejs-image]: ./docs/img/tech-stack/icon-nodejs-50.png\n[icon-npm-image]: ./docs/img/tech-stack/icon-npm-50.png\n[icon-package-image]: ./docs/img/icons8/icon-package-filled.png\n[icon-quote-left-image]: ./docs/img/icons8/icon-quote-left-25.png\n[icon-road-milestone-image]: ./docs/img/icons8/img-goal-filled-50.png\n[icon-standardjs-image]: ./docs/img/tech-stack/icon-standardjs-50.png\n[icon-travis-image]: ./docs/img/icons8/travis-ci-50.png\n[icon-user-manual-image]: ./docs/img/icons8/icon-user-manual-grey-50.png\n[icon-yeoman-image]: ./docs/img/tech-stack/icon-yeoman-50.png\n[icons8-license-url]: https://icons8.com/license/\n[issues-available-url]: /commonality/generator-community/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+Available%22\n[issues-new-defect-url]: https://github.com/commonality/generator-community/issues/new?title=fix%28affected-scope%29%3A+subject-line-with-very-few-words\u0026labels=Priority%3A+Medium%2CStatus%3A+Review+Needed%2CType%3A+Defect\u0026body=%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\n[issues-new-feat-url]: https://github.com/commonality/generator-community/issues/new?title=feat%28affected-scope%29%3A+subject-line-with-very-few-words\u0026labels=Priority%3A+Medium%2CStatus%3A+Review+Needed%2CType%3A+Feature\u0026body=%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\n[license-badge-image]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square\n[license-choose-url]: https://choosealicense.com/\n[license-no-license-url]: https://choosealicense.com/no-license/\n[license-unlicense-url]: https://choosealicense.com/licenses/#unlicense\n[license-url]: ./LICENSE\n[markdown-magic-toc-url]: https://github.com/DavidWells/markdown-magic#-toc\n[milestones-url]: https://github.com/commonality/generator-community/milestones\n[nodejs-url]: https://nodejs.org\n[notice-url]: ./NOTICE.md\n[npm-badge-image]: https://img.shields.io/npm/v/generator-community.svg?style=flat-square\n[npm-scripts-docs-url]: https://docs.npmjs.com/misc/scripts\n[npm-url]: https://npmjs.org/package/generator-community\n[npmjs-url]: https://www.npmjs.com/\n[nsp-badge-image]: https://nodesecurity.io/orgs/commonality/projects/0662674a-ad9f-4b2f-a930-30615e6222cd/badge?style=flat-square\n[nsp-sign-up-url]: https://nodesecurity.io/signup\n[nsp-url]: https://nodesecurity.io/orgs/commonality/projects/0662674a-ad9f-4b2f-a930-30615e6222cd\n[nvm-url]: https://github.com/creationix/nvm\n[opensource-guide-community-standards-url]: https://opensource.guide\n[pr-url]: /commonality/generator-community/pulls\n[prs-welcome-badge-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs-welcome-url]: http://makeapullrequest.com\n[quote-left-img]: ./docs/img/icons8/quote-left-25.png\n[readme-score-badge-image]: http://readme-score-api.herokuapp.com/score.svg?style=flat-square\u0026url=https://github.com/commonality/generator-community\n[readme-score-url]: http://clayallsopp.github.io/readme-score?url=https://github.com/commonality/generator-community\n[snyk-vulnerabilities-badge-image]: https://snyk.io/test/github/commonality/generator-community/badge.svg?style=flat-square\n[snyk-vulnerabilities-url]: https://snyk.io/test/github/commonality/generator-community\n[sonarcloud-url]: https://sonarcloud.io\n[stack-share-badge-image]: https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat-square\n[stack-share-news-feed-image]: ./docs/img/tech-stack/icon-news-feed-50.png\n[stack-share-news-feed-url]: https://stackshare.io/news/filter/75847/1724/save\n[stack-share-rss-feed-image]: ./docs/img/tech-stack/icon-rss-feed-50.png\n[stack-share-rss-feed-url]: https://stackshare.io/news/75847/1724/feed\n[stack-share-url]: https://stackshare.io/commonality/generator-community\n[standard-version-cut-a-release-url]: https://github.com/conventional-changelog/standard-version#cut-a-release\n[standardjs-badge-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square\n[standardjs-url]: https://standardjs.com/\n[travis-badge-image]: https://img.shields.io/travis/commonality/generator-community.svg?branch=master\u0026style=flat-square\n[travis-url]: https://travis-ci.org/commonality/generator-community\n[yeoman-url]: https://yeoman.io\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommonality%2Fgenerator-community","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcommonality%2Fgenerator-community","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcommonality%2Fgenerator-community/lists"}