An open API service indexing awesome lists of open source software.

https://github.com/mauricioabreu/contributors.cr

:octocat: List all contributors of a given Github project
https://github.com/mauricioabreu/contributors.cr

Last synced: about 2 months ago
JSON representation

:octocat: List all contributors of a given Github project

Awesome Lists containing this project

README

        

# contributors.cr [![Build Status](https://travis-ci.org/mauricioabreu/contributors.cr.svg?branch=master)](https://travis-ci.org/mauricioabreu/contributors.cr)

`Contributors` aims to provide an easy way to collect all contributors of a given project at Github.
Since Github only lists the top 100 contributors, this project has the goal to show you all people helping your project.

## Installation

Add this to your application's `shard.yml`:

```yaml
dependencies:
contributors:
github: mauricioabreu/contributors.cr
```

## Usage

Before running the command-line tool, add a `GITHUB_SECRET` to your environment variables.

You also need to compile the project. There is a `Makefile` that makes this task easy.

```shell
make build
```

```shell
$ ./contributors "veelenga/awesome-crystal"
```

## Contributing

1. Fork it ( https://github.com/mauricioabreu/contributors.cr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request