Skip to content

Commit

Permalink
docs: setup all-contributors
Browse files Browse the repository at this point in the history
Follow the https://github.com/kentcdodds/all-contributors specification for listing all contributors
  • Loading branch information
nokome committed Nov 27, 2018
1 parent fd7e936 commit b517389
Show file tree
Hide file tree
Showing 5 changed files with 273 additions and 2 deletions.
55 changes: 55 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{
"projectName": "dockter",
"projectOwner": "stencila",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"contributors": [
{
"login": "remram44",
"name": "Remi Rampin",
"avatar_url": "https://avatars3.githubusercontent.com/u/426784?v=4",
"profile": "https://remirampin.com/",
"contributions": [
"bug",
"code",
"ideas"
]
},
{
"login": "beneboy",
"name": "Ben",
"avatar_url": "https://avatars1.githubusercontent.com/u/292725?v=4",
"profile": "http://bbit.co.nz",
"contributions": [
"code",
"ideas"
]
},
{
"login": "apawlik",
"name": "Aleksandra Pawlik",
"avatar_url": "https://avatars2.githubusercontent.com/u/2358535?v=4",
"profile": "http://stenci.la",
"contributions": [
"code",
"example",
"bug"
]
},
{
"login": "nokome",
"name": "Nokome Bentley",
"avatar_url": "https://avatars0.githubusercontent.com/u/1152336?v=4",
"profile": "https://github.com/nokome",
"contributions": [
"code",
"test"
]
}
]
}
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,21 @@ npm run docs # or, make docs
open docs/index.html
```

### Contributors list

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Please add contribuors, including yourself, using,

```bash
# Add new contributor <username>, who made a contribution of type <contribution>
npm run contributors:add <username> <contribution>
# Example:
npm run contributors:add octocat code,doc
# Regenerate the readme table
npm run contributors:generate
```

See the list of contribution codes [here](https://www.npmjs.com/package/all-contributors-cli#addupdate-contributors).

### Commit messages

Please use [conventional changelog](https://github.com/conventional-changelog/conventional-changelog) style commit messages e.g. `docs(readme): fixed spelling mistake`. See [the specifications](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) for full details. This help with automated semantic versioning.
Expand Down
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Dockter : a Docker image builder for researchers

[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)
[![Build status](https://travis-ci.org/stencila/dockter.svg?branch=master)](https://travis-ci.org/stencila/dockter)
[![Code coverage](https://codecov.io/gh/stencila/dockter/branch/master/graph/badge.svg)](https://codecov.io/gh/stencila/dockter)
[![Greenkeeper badge](https://badges.greenkeeper.io/stencila/dockter.svg)](https://greenkeeper.io/)
Expand Down Expand Up @@ -390,9 +391,15 @@ Dockter is in initial development and mostly intended as a proof of concept of b
- Dec 2018: release of Dockter [1.0](https://github.com/stencila/dockter/milestone/2)
- Jan 2018: feactor out `Parser` and compilation code into a separate repo to be used by Docker and it's sister project targettting Nix

## Contribute
## Contributors

We 💕 contributions! All contributions: ideas 💡, bug reports 🐛, documentation 🗎, code 💾. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
We 💕 contributions! All contributions: ideas 🤔, examples 💡, bug reports 🐛, documentation 📖, code 💻, questions 💬. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Thanks 🙏 to these wonderful ✨ people who have contributed so far 💖!

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars3.githubusercontent.com/u/426784?v=4" width="100px;"/><br /><sub><b>Remi Rampin</b></sub>](https://remirampin.com/)<br />[🐛](https://github.com/stencila/dockter/issues?q=author%3Aremram44 "Bug reports") [💻](https://github.com/stencila/dockter/commits?author=remram44 "Code") [🤔](#ideas-remram44 "Ideas, Planning, & Feedback") | [<img src="https://avatars1.githubusercontent.com/u/292725?v=4" width="100px;"/><br /><sub><b>Ben</b></sub>](http://bbit.co.nz)<br />[💻](https://github.com/stencila/dockter/commits?author=beneboy "Code") [🤔](#ideas-beneboy "Ideas, Planning, & Feedback") | [<img src="https://avatars2.githubusercontent.com/u/2358535?v=4" width="100px;"/><br /><sub><b>Aleksandra Pawlik</b></sub>](http://stenci.la)<br />[💻](https://github.com/stencila/dockter/commits?author=apawlik "Code") [💡](#example-apawlik "Examples") [🐛](https://github.com/stencila/dockter/issues?q=author%3Aapawlik "Bug reports") | [<img src="https://avatars0.githubusercontent.com/u/1152336?v=4" width="100px;"/><br /><sub><b>Nokome Bentley</b></sub>](https://github.com/nokome)<br />[💻](https://github.com/stencila/dockter/commits?author=nokome "Code") [⚠️](https://github.com/stencila/dockter/commits?author=nokome "Tests") |
| :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

## See also

Expand Down Expand Up @@ -467,3 +474,15 @@ Dockter was inspired by, and combines ideas from, several similar tools includin
- [`pypa`](https://warehouse.pypa.io)
- [`sysreqsdb`](https://github.com/r-hub/sysreqsdb)
- and of course, [Docker](https://www.docker.com/)

## Contributors

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
| [<img src="https://avatars3.githubusercontent.com/u/426784?v=4" width="100px;"/><br /><sub><b>Remi Rampin</b></sub>](https://remirampin.com/)<br />[🐛](https://github.com/stencila/dockter/issues?q=author%3Aremram44 "Bug reports") [💻](https://github.com/stencila/dockter/commits?author=remram44 "Code") [🤔](#ideas-remram44 "Ideas, Planning, & Feedback") | [<img src="https://avatars1.githubusercontent.com/u/292725?v=4" width="100px;"/><br /><sub><b>Ben</b></sub>](http://bbit.co.nz)<br />[💻](https://github.com/stencila/dockter/commits?author=beneboy "Code") [🤔](#ideas-beneboy "Ideas, Planning, & Feedback") | [<img src="https://avatars2.githubusercontent.com/u/2358535?v=4" width="100px;"/><br /><sub><b>Aleksandra Pawlik</b></sub>](http://stenci.la)<br />[💻](https://github.com/stencila/dockter/commits?author=apawlik "Code") [💡](#example-apawlik "Examples") [🐛](https://github.com/stencila/dockter/issues?q=author%3Aapawlik "Bug reports") | [<img src="https://avatars0.githubusercontent.com/u/1152336?v=4" width="100px;"/><br /><sub><b>Nokome Bentley</b></sub>](https://github.com/nokome)<br />[💻](https://github.com/stencila/dockter/commits?author=nokome "Code") [⚠️](https://github.com/stencila/dockter/commits?author=nokome "Tests") |
| :---: | :---: | :---: | :---: |
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
179 changes: 179 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
"scripts": {
"lint": "tslint --project tsconfig.json --fix --format stylish ./src/**/*.ts",
"test": "jest",
"contributors:add": "all-contributors add",
"contributors:generate": "all-contributors generate",
"cover": "jest --collectCoverage",
"build": "npm run build-dist && npm run build-bins",
"build-dist": "tsc && cp ./src/*.json dist",
Expand Down Expand Up @@ -59,6 +61,7 @@
"@types/tar-fs": "^1.16.1",
"@types/tmp": "0.0.33",
"@types/yargs": "^12.0.1",
"all-contributors-cli": "^5.4.1",
"commitizen": "^3.0.4",
"cz-conventional-changelog": "^2.1.0",
"jest": "^23.6.0",
Expand Down

0 comments on commit b517389

Please sign in to comment.