Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mntnr/build-a-space
Automatically add community documentation to your repository
https://github.com/mntnr/build-a-space
api automatic bot community github
Last synced: 5 days ago
JSON representation
Automatically add community documentation to your repository
- Host: GitHub
- URL: https://github.com/mntnr/build-a-space
- Owner: mntnr
- License: mit
- Created: 2017-10-02T18:11:45.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-16T09:52:04.000Z (over 4 years ago)
- Last Synced: 2024-05-19T14:35:12.911Z (6 months ago)
- Topics: api, automatic, bot, community, github
- Language: JavaScript
- Homepage: https://maintainer.io
- Size: 825 KB
- Stars: 20
- Watchers: 2
- Forks: 3
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - mntnr/build-a-space - Automatically add community documentation to your repository (github)
README
# Build A Space
[](https://travis-ci.org/mntnr/build-a-space) [](https://greenkeeper.io/)
> Automatically add community documentation to your repository
## Background
I 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?
This 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.
The 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.
## Install
You can install this globally with npm:
```
$ npm install -g build-a-space
```
You'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.
You _may_ be able to install this locally and include it, but I have no idea how it would react.
## Usage
```
Usage
$ build-a-space [opts]
Options
-f, --fork Create and use a fork instead of pushing to a branch
-t, --test Don't open issues or create pull requests
-c, --config The path to a configuration file
-b, --branch The default branch to use instead of 'master'
--email The email for the Code of Conduct
--licensee The person to license the repository to
--travis Edit the Travis file
--open Open the PR url afterwards
Examples
$ build-a-space mntnr/build-a-space
```
Substitute another repo as needed. It drives itself from there.
### Configuration
You 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.
```
$ build-a-space -c=config.json
```
And, in `config.json`:
```
{
"email": "[email protected]",
"licensee": "Richard Littauer",
"contributing": "./contributing.md"
}
```
The contributing file path needs to be in the `build-a-space` directory.
## Maintainers
[Me](https://burntfen.com).
And [you](https://github.com/mntnr/build-a-space/issues/new?title=I%20want%20to%20be%20a%20maintainer!)?
## Contribute
I 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.
Check out the [Contributing guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) for more.
## License
[MIT](LICENSE) © 2017 Richard Littauer