{"id":20511355,"url":"https://github.com/friedrith/contributing-generator","last_synced_at":"2025-04-13T22:42:10.988Z","repository":{"id":226510115,"uuid":"767811678","full_name":"friedrith/contributing-generator","owner":"friedrith","description":"A generator for the CONTRIBUTING.md, README.md, LICENSE, etc","archived":false,"fork":false,"pushed_at":"2024-03-16T17:46:43.000Z","size":323,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-12T05:02:44.583Z","etag":null,"topics":["cli","contributing","markdown","npm"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/contributing-generator","language":"TypeScript","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/friedrith.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-05T23:54:48.000Z","updated_at":"2024-04-25T12:20:39.000Z","dependencies_parsed_at":"2024-03-09T13:24:53.073Z","dependency_job_id":"950913bc-c196-47b8-92fa-a70d67f5daac","html_url":"https://github.com/friedrith/contributing-generator","commit_stats":null,"previous_names":["friedrith/contributing-generator"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friedrith%2Fcontributing-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friedrith%2Fcontributing-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friedrith%2Fcontributing-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/friedrith%2Fcontributing-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/friedrith","download_url":"https://codeload.github.com/friedrith/contributing-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248794565,"owners_count":21162613,"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":["cli","contributing","markdown","npm"],"created_at":"2024-11-15T20:35:39.952Z","updated_at":"2025-04-13T22:42:10.958Z","avatar_url":"https://github.com/friedrith.png","language":"TypeScript","funding_links":[],"categories":["\u003ca name=\"programming-boilerplate\"\u003e\u003c/a\u003eProgram templates and boilerplate"],"sub_categories":[],"readme":"# contributing-generator\n\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/friedrith/contributing-generator/release.yml)\n![NPM Version](https://img.shields.io/npm/v/contributing-generator)\n\nA smart and interactive prompt to generate documentation in **CONTRIBUTING.md**, **LICENSE**, **CODE_OF_CONDUCT.md**, **package.json**, **SECURITY.md** and **README.md** files for your project.\n\n`contributing-generator` gathers as maximum information as possible from your git configuration, package.json and github profile to generate the files.\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src='https://github.com/friedrith/contributing-generator/assets/4005226/ca24bc9a-d8a4-4f78-bb78-478729138ff4' alt=\"demo of contributing-generator\" height=\"300\"\u003e\n\u003c/div\u003e\n\n## Get Started\n\n```bash\n$ npx contributing-generator\n\n\n? What do you want to generate? (Use arrow keys)\n❯ license\n  contributing\n  readme\n  code_of_conduct\n  pull_request_template\n  package\n  security\n```\n\nCheck the templates of these files in the [templates](./templates) folder.\n\n\u003e We suggest you to commit your changes before running the generator, as it will overwrite some files and you might want to revert some changes.\n\n## Why using contributing-generator?\n\nIn comparison of other tools, it is smart and interactive. It will detect the license if existing, the year, the organization name from your github or gitlab and a lot of other information.\n\n```bash\n? What do you want to generate? license\n? Choose a license: MIT # \u003c-- coming from your package.json\n? Year: 2024\n? Organization: John Smith # \u003c-- coming from your github profile\n? Path: (/Users/john/code/contributing-generator)\n```\n\n\u003e `contributing-generator` was tested with github, gitlab and bitbucket.\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code practices and the process for submitting pull requests.\n\n```bash\npnpm install # Install dependencies\n\npnpm dev # Start the project\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriedrith%2Fcontributing-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffriedrith%2Fcontributing-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffriedrith%2Fcontributing-generator/lists"}