{"id":13465042,"url":"https://github.com/WeAllJS/weallbehave","last_synced_at":"2025-03-25T13:32:58.717Z","repository":{"id":65412509,"uuid":"82476159","full_name":"WeAllJS/weallbehave","owner":"WeAllJS","description":"CODE_OF_CONDUCT.md generator","archived":false,"fork":false,"pushed_at":"2020-09-27T21:53:20.000Z","size":28,"stargazers_count":190,"open_issues_count":2,"forks_count":23,"subscribers_count":10,"default_branch":"latest","last_synced_at":"2024-05-19T14:35:19.114Z","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}},"created_at":"2017-02-19T17:24:05.000Z","updated_at":"2024-04-19T09:52:01.000Z","dependencies_parsed_at":"2023-01-22T08:05:43.299Z","dependency_job_id":null,"html_url":"https://github.com/WeAllJS/weallbehave","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallbehave","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallbehave/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallbehave/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WeAllJS%2Fweallbehave/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WeAllJS","download_url":"https://codeload.github.com/WeAllJS/weallbehave/tar.gz/refs/heads/latest","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221962484,"owners_count":16908339,"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.866Z","updated_at":"2024-10-29T16:30:33.070Z","avatar_url":"https://github.com/WeAllJS.png","language":"JavaScript","readme":"# weallbehave [![npm version](https://img.shields.io/npm/v/weallbehave.svg)](https://npm.im/weallbehave) [![license](https://img.shields.io/npm/l/weallbehave.svg)](https://npm.im/weallbehave) [![Travis](https://img.shields.io/travis/wealljs/weallbehave.svg)](https://travis-ci.org/wealljs/weallbehave) [![AppVeyor](https://ci.appveyor.com/api/projects/status/github/wealljs/weallbehave?svg=true)](https://ci.appveyor.com/project/wealljs/weallbehave) [![Coverage Status](https://coveralls.io/repos/github/wealljs/weallbehave/badge.svg?branch=latest)](https://coveralls.io/github/wealljs/weallbehave?branch=latest)\n\n[`weallbehave`](https://npm.im/weallbehave) is a command-line tool for automatically generating and updating the [`CODE_OF_CONDUCT.md`](https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/) for your projects.\n\nYou can configure the maintainers that will enforce the CoC by adding `author` and `contributors` fields to `package.json`. Currently `email` and `twitter` are supported. You can exclude maintainers from enforcement duties by adding `\"coc-enforcer\": false` to their author/contributors entry.\n\n## Install\n\n#### Locally to your npm project (recommended):\n\n`$ npm install --save-dev weallbehave`\n\n#### Globally:\n\n`$ npm install -g weallbehave`\n\n## Example\n\n### npm repo\n```javascript\n// package.json\n{\n  \"scripts\": {\n    \"update-coc\": \"weallbehave -o . \u0026\u0026 git add CODE_OF_CONDUCT.md \u0026\u0026 git commit -m 'docs(coc): updated CODE_OF_CONDUCT.md'\"\n  },\n  \"author\": {\n    \"name\": \"Alice\",\n    \"email\": \"pwnu@sekrit.hax\",\n    \"twitter\": \"@socialistengineering\"\n  },\n  \"contributors\": [\n    {\n      \"name\": \"Bob\",\n      \"email\": \"me@friendly.bob\",\n      \"coc-enforcer\": false\n    },\n    {\n      \"name\": \"Catherine\",\n      \"email\": \"this@kitty.slays\"\n    }\n  ]\n}\n// Now you can do `npm run update-coc` any time you\n// bump your `weallbehave` 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 `coc.md`\n$ weallbehave \u003e coc.md\n\n# Write a CODE_OF_CONDUCT.md document to the ./foo dir.\n$ weallbehave -o ./foo\n```\n","funding_links":[],"categories":["JavaScript","📦 Legacy \u0026 Inactive Projects","Uncategorized","others"],"sub_categories":["Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWeAllJS%2Fweallbehave","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWeAllJS%2Fweallbehave","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWeAllJS%2Fweallbehave/lists"}