{"id":14982231,"url":"https://github.com/generate/generate-contributing","last_synced_at":"2025-10-12T23:40:53.254Z","repository":{"id":57246065,"uuid":"61659838","full_name":"generate/generate-contributing","owner":"generate","description":"Generate a contributing.md file for a project. Can also be used as a building block to add this functionality to another generator.","archived":false,"fork":false,"pushed_at":"2018-01-25T12:35:19.000Z","size":276,"stargazers_count":17,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-27T12:32:21.090Z","etag":null,"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"],"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/generate.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-06-21T19:06:40.000Z","updated_at":"2025-02-06T15:32:49.000Z","dependencies_parsed_at":"2022-08-24T16:31:36.654Z","dependency_job_id":null,"html_url":"https://github.com/generate/generate-contributing","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/generate/generate-contributing","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-contributing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-contributing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-contributing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-contributing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/generate","download_url":"https://codeload.github.com/generate/generate-contributing/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/generate%2Fgenerate-contributing/sbom","scorecard":{"id":422278,"data":{"date":"2025-08-11","repo":{"name":"github.com/generate/generate-contributing","commit":"e9becbfd164ede91246446200039cf6661d8ae1e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}}]},"last_synced_at":"2025-08-19T01:31:18.644Z","repository_id":57246065,"created_at":"2025-08-19T01:31:18.645Z","updated_at":"2025-08-19T01:31:18.645Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279013412,"owners_count":26085274,"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","status":"online","status_checked_at":"2025-10-12T02:00:06.719Z","response_time":53,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["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"],"created_at":"2024-09-24T14:04:59.508Z","updated_at":"2025-10-12T23:40:53.218Z","avatar_url":"https://github.com/generate.png","language":"JavaScript","readme":"\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://github.com/generate/generate\"\u003e\n\u003cimg height=\"150\" width=\"150\" src=\"https://raw.githubusercontent.com/generate/generate/master/docs/logo.png\"\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\nGenerate 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.\n\n# generate-contributing\n\n[![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)\n\n![generate-contributing demo](https://raw.githubusercontent.com/generate/generate-contributing/master/docs/demo.gif)\n\n- [Getting started](#getting-started)\n  * [Install](#install)\n  * [CLI](#cli)\n  * [Help](#help)\n- [Available tasks](#available-tasks)\n  * [contributing](#contributing)\n  * [contributing:it](#contributingit)\n  * [contributing:itb](#contributingitb)\n  * [contributing:itd](#contributingitd)\n  * [contributing:pr](#contributingpr)\n  * [contributing:prd](#contributingprd)\n- [Next steps](#next-steps)\n  * [Running unit tests](#running-unit-tests)\n  * [Publishing your generator](#publishing-your-generator)\n- [About](#about)\n  * [What is \"Generate\"?](#what-is-generate)\n  * [Related projects](#related-projects)\n  * [Community](#community)\n  * [Contributors](#contributors)\n  * [Contributing](#contributing)\n  * [Running tests](#running-tests)\n  * [Author](#author)\n  * [License](#license)\n\n_(TOC generated by [verb](https://github.com/verbose/verb) using [markdown-toc](https://github.com/jonschlinkert/markdown-toc))_\n\n## Getting started\n\n### Install\n\n**Installing the CLI**\n\nTo 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:\n\n```sh\n$ npm install --global generate\n```\n\nThis adds the `gen` command to your system path, allowing it to be run from any directory.\n\n**Install generate-contributing**\n\nInstall this module with the following command:\n\n```sh\n$ npm install --global generate-contributing\n```\n\n### CLI\n\nRun this generator's `default` [task](https://github.com/generate/generate/blob/master/docs/tasks.md#default) with the following command:\n\n```sh\n$ gen readme\n```\n\n**What you should see in the terminal**\n\nIf completed successfully, you should see both `starting` and `finished` events in the terminal, like the following:\n\n```sh\n[00:44:21] starting ...\n...\n[00:44:22] finished ✔\n```\n\nIf you do not see one or both of those events, please [let us know about it](../../issues).\n\n### Help\n\nTo see a general help menu and available commands for Generate's CLI, run:\n\n```sh\n$ gen help\n```\n\n## Available tasks\n\nAll available tasks for this generator.\n\n### [contributing](generator.js#L26)\n\nGenerate a `contributing.md` file.\n\n**Example**\n\n```sh\n$ gen contributing\n$ gen contributing --dest ./docs\n```\n\n### [contributing:it](generator.js#L42)\n\nGenerate an `issue_template.md` file to the `.github/` directory, or specified `--dest`.\n\n**Example**\n\n```sh\n$ gen contributing:it\n$ gen contributing:it --dest ./docs\n# also aliased as the following (mostly for API usage)\n$ gen contributing:issue_template\n```\n\n### [contributing:itb](generator.js#L59)\n\nGenerate a bare bones `issue_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/issue_template_basic.md).\n\n**Example**\n\n```sh\n$ gen contributing:itb\n$ gen contributing:itb --dest ./docs\n# also aliased as the following (mostly for API usage)\n$ gen contributing:issue_template_detailed\n```\n\n### [contributing:itd](generator.js#L76)\n\nGenerate a detailed `issue_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/issue_template_detailed.md)\n\n**Example**\n\n```sh\n$ gen contributing:itd\n$ gen contributing:itd --dest ./docs\n# also aliased as the following (mostly for API usage)\n$ gen contributing:issue_template_detailed\n```\n\n### [contributing:pr](generator.js#L93)\n\nGenerate a `pull_request_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/pull_request_template.md).\n\n**Example**\n\n```sh\n$ gen contributing:pr\n$ gen contributing:pr --dest ./docs\n# also aliased as the following (mostly for API usage)\n$ gen contributing:pr_template\n```\n\n### [contributing:prd](generator.js#L110)\n\nGenerate a detailed `pull_request_template.md` file to the `.github/` directory, or specified `--dest`. Uses [this template](templates/pull_request_template_detailed.md).\n\n**Example**\n\n```sh\n$ gen contributing:prd\n$ gen contributing:prd --dest ./docs\n# also aliased as the following (for API usage, when it helps to be explicit in code)\n$ gen contributing:pr_template_detailed\n```\n\nVisit Generate's [documentation for tasks](https://github.com/generate/generate/blob/master/docs/tasks.md).\n\n## Next steps\n\n### Running unit tests\n\nIt'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:\n\n```sh\n$ npm install \u0026\u0026 test\n```\n\n### Publishing your generator\n\nIf 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:\n\n**Are you sure you're ready?!**\n\nLet's go!\n\n```sh\n$ npm publish\n```\n\n## About\n\n### What is \"Generate\"?\n\nGenerate 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).\n\nAnswers 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.\n\n**For more information**:\n\n* Visit the [generate project](https://github.com/generate/generate/)\n* Visit the [generate documentation](https://github.com/generate/generate/blob/master/docs/)\n* 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))\n\n### Related projects\n\n* [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.\")\n* [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.\")\n* [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.\")\n* [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.\")\n\n### Community\n\nBigger community means more plugins, better support and more progress. Help us make Generate better by spreading the word:\n\n* Show your love by starring the project\n* Tweet about Generate. Mention using `@generatejs`, or use the `#generatejs` hashtag\n* Get implementation help on [StackOverflow](http://stackoverflow.com/questions/tagged/generate) with the `generatejs` tag\n* Discuss Generate with us on [Gitter](https://gitter.im/generate/generate)\n* 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.\n\n### Contributors\n\n| **Commits** | **Contributor** | \n| --- | --- |\n| 30 | [jonschlinkert](https://github.com/jonschlinkert) |\n| 3 | [pointnet](https://github.com/pointnet) |\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.\n\n### Running tests\n\nRunning 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:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on January 25, 2018._","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-contributing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenerate%2Fgenerate-contributing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenerate%2Fgenerate-contributing/lists"}