Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikhita/github-contrib
Generate a list of PRs and Issues you contributed across all repos in an org :rocket:
https://github.com/nikhita/github-contrib
Last synced: about 2 months ago
JSON representation
Generate a list of PRs and Issues you contributed across all repos in an org :rocket:
- Host: GitHub
- URL: https://github.com/nikhita/github-contrib
- Owner: nikhita
- License: mit
- Created: 2017-08-20T18:22:03.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-14T03:59:43.000Z (over 3 years ago)
- Last Synced: 2024-08-04T04:03:08.142Z (4 months ago)
- Language: Go
- Homepage:
- Size: 3.89 MB
- Stars: 93
- Watchers: 5
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - github-contrib - Generate a list of PRs and Issues you contributed across all repos in an org :rocket: (Go)
README
# github-contrib
github-contrib is a tool to create a list of the following for a contributor across all repos in a Github organization.
1. Pull Requests created.
2. Issues created.
3. Pull Requests reviewed.
The output will be in the markdown format. You can copy and paste the output to a markdown file ([Sample Output](/output/sample-output.md)) and proudly show it to others. :sunglasses:
Also, a friendly reminder that contributions are not limited to code - it is about much more than that!
## Installation
**Prerequisites**: Go version 1.7 or greater.
1. Get the code
```
$ go get github.com/nikhita/github-contrib
```
2. Build
```
$ cd $GOPATH/src/github.com/nikhita/github-contrib
$ go install
```
## Usage
Since Github enforces a rate limit on requests, you will need a personal API token. You can find more details about generating an API token [here](https://github.com/blog/1509-personal-api-tokens).
Please note that Github has a rate limit of 30 requests per minute for the search API so this will take some time fetch all results.
But don't worry, it should not take more than a few minutes! :smile:
The org and github-handle arguments are currently mandatory.
```
github-contrib : v0.1.0
USAGE:
github-contrib -token=
-token string
Mandatory GitHub API token
-v print version and exit (shorthand)
-version
print version and exit
```
Example: get contribution list for `nikhita` against `kubernetes` community.
```
# github-contrib -token= kubernetes nikhita
```
## Output
The maximum number of created Pull Requests which are displayed for each repository is 100. They are displayed in the descending order of creation.
The output is in the markdown format. You can copy and paste it in a markdown file and share it as a gist, etc.
**TODO**:
The following are pretty easy to accomplish but lead to a lot of API calls making it potentially slower.
- [ ] Allow displaying more than 100 Pull Requests for each repo.
- [ ] Make the org argument optional.
## License
github-contrib is licensed under the [MIT License](/LICENSE).