{"id":13465043,"url":"https://github.com/WeAllJS/weallcontribute","last_synced_at":"2025-03-25T13:32:54.750Z","repository":{"id":45603794,"uuid":"82476125","full_name":"WeAllJS/weallcontribute","owner":"WeAllJS","description":"CONTRIBUTING.md generator","archived":false,"fork":false,"pushed_at":"2023-10-21T01:38:12.000Z","size":400,"stargazers_count":162,"open_issues_count":12,"forks_count":37,"subscribers_count":8,"default_branch":"latest","last_synced_at":"2024-05-19T14:35:20.342Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WeAllJS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2017-02-19T17:23:33.000Z","updated_at":"2024-04-19T09:52:02.000Z","dependencies_parsed_at":"2023-01-23T11:10:17.122Z","dependency_job_id":"6905565d-9e3d-435d-b965-82a656ccf0ec","html_url":"https://github.com/WeAllJS/weallcontribute","commit_stats":{"total_commits":28,"total_committers":6,"mean_commits":4.666666666666667,"dds":0.3928571428571429,"last_synced_commit":"d40bfec8c0ea5f1e17bed104d189a83ab86bb3fe"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallcontribute","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallcontribute/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallcontribute/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallcontribute/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WeAllJS","download_url":"https://codeload.github.com/WeAllJS/weallcontribute/tar.gz/refs/heads/latest","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222081864,"owners_count":16928114,"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":[],"created_at":"2024-07-31T14:00:55.885Z","updated_at":"2024-10-29T16:30:29.709Z","avatar_url":"https://github.com/WeAllJS.png","language":"JavaScript","readme":"# weallcontribute [![npm version](https://img.shields.io/npm/v/weallcontribute.svg)](https://npm.im/weallcontribute) [![license](https://img.shields.io/npm/l/weallcontribute.svg)](https://npm.im/weallcontribute) [![Travis](https://img.shields.io/travis/wealljs/weallcontribute.svg)](https://travis-ci.org/wealljs/weallcontribute) [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/wealljs/weallcontribute?svg=true)](https://ci.appveyor.com/project/wealljs/weallcontribute) [![Coverage Status](https://coveralls.io/repos/github/wealljs/weallcontribute/badge.svg?branch=latest)](https://coveralls.io/github/wealljs/weallcontribute?branch=latest)\n\n[`weallcontribute`](https://npm.im/weallcontribute) is a command-line tool for automatically generating and updating [`CONTRIBUTING.md`](https://github.com/blog/1184-contributing-guidelines) guidelines for your projects.\n\n## Install\n\n#### Locally to your npm project (recommended):\n\n`$ npm install --save-dev weallcontribute`\n\n#### Globally:\n\n`$ npm install -g weallcontribute`\n\n## Example\n\n### npm repo\n```javascript\n// package.json\n{\n  \"scripts\": {\n    \"update-contrib\": \"weallcontribute -o . \u0026\u0026 git add CONTRIBUTING.md \u0026\u0026 git commit -m 'docs(contributing): updated CONTRIBUTING.md'\"\n  }\n}\n// Now you can do `npm run update-contrib` any time you\n// bump your `weallcontribute` version to bring your docs\n// up to date! And you don't need a global install!\n```\n\n### Global CLI install\n```sh\n# Read your repo info from package.json or git\n# and pipe the output to `contribs.md`\n$ weallcontribute \u003e contribs.md\n\n# Write a CONTRIBUTING.md document for org/proj to the ./foo dir.\n$ weallcontribute org/proj -o ./foo\n```\n","funding_links":[],"categories":["JavaScript","📦 Legacy \u0026 Inactive Projects","Uncategorized","Templates"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWeAllJS%2Fweallcontribute","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWeAllJS%2Fweallcontribute","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWeAllJS%2Fweallcontribute/lists"}