{"id":13554027,"url":"https://github.com/mntnr/build-a-space","last_synced_at":"2025-04-03T06:31:01.602Z","repository":{"id":57191154,"uuid":"105567820","full_name":"mntnr/build-a-space","owner":"mntnr","description":"Automatically add community documentation to your repository","archived":false,"fork":false,"pushed_at":"2020-05-16T09:52:04.000Z","size":845,"stargazers_count":20,"open_issues_count":44,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-19T14:35:12.911Z","etag":null,"topics":["api","automatic","bot","community","github"],"latest_commit_sha":null,"homepage":"https://maintainer.io","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/mntnr.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-10-02T18:11:45.000Z","updated_at":"2024-02-13T14:11:54.000Z","dependencies_parsed_at":"2022-09-15T22:23:06.001Z","dependency_job_id":null,"html_url":"https://github.com/mntnr/build-a-space","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/mntnr%2Fbuild-a-space","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntnr%2Fbuild-a-space/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntnr%2Fbuild-a-space/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mntnr%2Fbuild-a-space/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mntnr","download_url":"https://codeload.github.com/mntnr/build-a-space/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246947861,"owners_count":20859331,"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":["api","automatic","bot","community","github"],"created_at":"2024-08-01T12:02:38.231Z","updated_at":"2025-04-03T06:31:01.087Z","avatar_url":"https://github.com/mntnr.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","Uncategorized","github"],"sub_categories":["Uncategorized"],"readme":"# Build A Space\n\n[![Build Status](https://travis-ci.org/mntnr/build-a-space.svg?branch=master)](https://travis-ci.org/mntnr/build-a-space) [![Greenkeeper badge](https://badges.greenkeeper.io/mntnr/build-a-space.svg)](https://greenkeeper.io/)\n\n\u003e Automatically add community documentation to your repository\n\n## Background\n\nI often clean up repositories, and have ideas for what I want to add to them. However, just as often, I manually add files to repositories. [@gr2m](https://github.com/gr2m) got me thinking - wouldn't it be better if I could automatically add files to a repository, using a GitHub bot?\n\nThis GitHub bot does _just that_. It adds a Contributing guide, a Code of Conduct, a README if you don't have one stubbed out, a License, and more to a repository. It lints your `package.json`. It tells you if you don't have an email specified in your CoC. It does a lot of stuff.\n\nThe point is to make building a space for community to grow _easier_. This stuff isn't rocket science, but doing it manually day after day is the hard part. Let's make it easier to build a space.\n\n## Install\n\nYou can install this globally with npm:\n\n```\n$ npm install -g build-a-space\n```\n\nYou'll need a [GitHub token](https://github.com/settings/tokens). Put it in the `env.js` file, or in a `$BUILD_A_SPACE` token in your environment.\n\nYou _may_ be able to install this locally and include it, but I have no idea how it would react.\n\n## Usage\n\n```\nUsage\n  $ build-a-space \u003cinput\u003e [opts]\n\nOptions\n  -f, --fork  Create and use a fork instead of pushing to a branch\n  -t, --test  Don't open issues or create pull requests\n  -c, --config  The path to a configuration file\n  -b, --branch  The default branch to use instead of 'master'\n  --email     The email for the Code of Conduct\n  --licensee  The person to license the repository to\n  --travis    Edit the Travis file\n  --open      Open the PR url afterwards\n\nExamples\n  $ build-a-space mntnr/build-a-space\n```\n\nSubstitute another repo as needed. It drives itself from there.\n\n### Configuration\n\nYou can specify a configuration file to stop having to type lots and lots of flags for multiple repositories. This will overwrite any flags you send in.\n\n```\n$ build-a-space -c=config.json\n```\n\nAnd, in `config.json`:\n\n```\n{\n  \"email\": \"richard@maintainer.io\",\n  \"licensee\": \"Richard Littauer\",\n  \"contributing\": \"./contributing.md\"\n}\n```\n\nThe contributing file path needs to be in the `build-a-space` directory.\n\n## Maintainers\n\n[Me](https://burntfen.com).\n\nAnd [you](https://github.com/mntnr/build-a-space/issues/new?title=I%20want%20to%20be%20a%20maintainer!)?\n\n## Contribute\n\nI would love for this to be a community effort. For now, I am hacking away at it because I want to be able to use it quickly get various documents into place as needed for different organizations I work with. However, if would be great if others would start using it, as well.\n\nCheck out the [Contributing guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) for more.\n\n## License\n\n[MIT](LICENSE) © 2017 Richard Littauer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmntnr%2Fbuild-a-space","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmntnr%2Fbuild-a-space","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmntnr%2Fbuild-a-space/lists"}