Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jdennes/contribution-checker
Check whether GitHub commits qualify as contributions.
https://github.com/jdennes/contribution-checker
contributions github github-api ruby
Last synced: about 1 month ago
JSON representation
Check whether GitHub commits qualify as contributions.
- Host: GitHub
- URL: https://github.com/jdennes/contribution-checker
- Owner: jdennes
- License: mit
- Created: 2014-06-05T08:16:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-21T21:21:38.000Z (over 7 years ago)
- Last Synced: 2024-09-20T06:19:16.400Z (3 months ago)
- Topics: contributions, github, github-api, ruby
- Language: Ruby
- Homepage:
- Size: 76.2 KB
- Stars: 34
- Watchers: 5
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# GitHub Contribution Checker
People :heart: GitHub Contributions. However, it's not always simple to tell why a commit isn't [counted as a contribution][contributions]. This library lets you check whether a specific commit qualifies as a contribution.
## Developing
To start working on the project:
```sh
script/bootstrap
```
To run the specs:
```sh
script/test
```
## Usage
```ruby
require "contribution-checker"
checker = ContributionChecker::Checker.new \
:access_token => "",
:commit_url => "https://github.com/user/repo/commit/sha"
checker.check
=> {
:contribution => true,
:and_criteria => {
:commit_email_is_not_generic => true,
:commit_in_valid_branch => true,
:repo_not_a_fork => true,
:commit_email_linked_to_user => true,
:commit_email => "[email protected]",
:default_branch => "master"
},
:or_criteria => {
:user_has_starred_repo => false,
:user_can_push_to_repo => false,
:user_is_repo_org_member => true,
:user_has_fork_of_repo => false,
:user_has_opened_issue_or_pr_in_repo => false
}
}
```
## App
You might like to try out the [Contribution Checker][app] app built on top of this library:
The source for the app is in [jdennes/contribution-checker-app][contribution-checker-app].
Created by [@izuzak][izuzak] and [@jdennes][jdennes] at the [Hamburg Hackathon][hamburg-hackathon], June 2014.
[contributions]: https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile
[app]: http://contribution-checker.herokuapp.com/
[contribution-checker-app]: https://github.com/jdennes/contribution-checker-app
[izuzak]: https://github.com/izuzak
[jdennes]: https://github.com/jdennes
[hamburg-hackathon]: http://hamburg-hackathon.de/hackathon/