{"id":21020142,"url":"https://github.com/jdennes/contribution-checker","last_synced_at":"2025-05-15T07:33:52.582Z","repository":{"id":17707313,"uuid":"20517235","full_name":"jdennes/contribution-checker","owner":"jdennes","description":"Check whether GitHub commits qualify as contributions.","archived":false,"fork":false,"pushed_at":"2017-09-21T21:21:38.000Z","size":78,"stargazers_count":34,"open_issues_count":0,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-13T07:17:56.952Z","etag":null,"topics":["contributions","github","github-api","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jdennes.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-06-05T08:16:43.000Z","updated_at":"2025-03-04T20:08:16.000Z","dependencies_parsed_at":"2022-09-14T11:20:49.254Z","dependency_job_id":null,"html_url":"https://github.com/jdennes/contribution-checker","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdennes%2Fcontribution-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdennes%2Fcontribution-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdennes%2Fcontribution-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jdennes%2Fcontribution-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jdennes","download_url":"https://codeload.github.com/jdennes/contribution-checker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254297116,"owners_count":22047430,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["contributions","github","github-api","ruby"],"created_at":"2024-11-19T10:35:49.285Z","updated_at":"2025-05-15T07:33:52.223Z","avatar_url":"https://github.com/jdennes.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Contribution Checker\n\nPeople :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.\n\n## Developing\n\nTo start working on the project:\n\n```sh\nscript/bootstrap\n```\n\nTo run the specs:\n\n```sh\nscript/test\n```\n\n## Usage\n\n```ruby\nrequire \"contribution-checker\"\n\nchecker = ContributionChecker::Checker.new \\\n  :access_token =\u003e \"\u003cYour 40 char GitHub API token\u003e\",\n  :commit_url   =\u003e \"https://github.com/user/repo/commit/sha\"\n\nchecker.check\n=\u003e {\n  :contribution =\u003e true,\n  :and_criteria =\u003e {\n    :commit_email_is_not_generic =\u003e true,\n    :commit_in_valid_branch      =\u003e true,\n    :repo_not_a_fork             =\u003e true,\n    :commit_email_linked_to_user =\u003e true,\n    :commit_email                =\u003e \"me@foo.com\",\n    :default_branch              =\u003e \"master\"\n  },\n  :or_criteria =\u003e {\n    :user_has_starred_repo               =\u003e false,\n    :user_can_push_to_repo               =\u003e false,\n    :user_is_repo_org_member             =\u003e true,\n    :user_has_fork_of_repo               =\u003e false,\n    :user_has_opened_issue_or_pr_in_repo =\u003e false\n  }\n}\n```\n\n## App\n\nYou might like to try out the [Contribution Checker][app] app built on top of this library:\n\n![checker](https://cloud.githubusercontent.com/assets/65057/6320756/b32c9328-bae6-11e4-9ba1-48ced9a5fb6e.png)\n\nThe source for the app is in [jdennes/contribution-checker-app][contribution-checker-app].\n\nCreated by [@izuzak][izuzak] and [@jdennes][jdennes] at the [Hamburg Hackathon][hamburg-hackathon], June 2014.\n\n[contributions]: https://help.github.com/articles/why-are-my-contributions-not-showing-up-on-my-profile\n[app]: http://contribution-checker.herokuapp.com/\n[contribution-checker-app]: https://github.com/jdennes/contribution-checker-app\n[izuzak]: https://github.com/izuzak\n[jdennes]: https://github.com/jdennes\n[hamburg-hackathon]: http://hamburg-hackathon.de/hackathon/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdennes%2Fcontribution-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjdennes%2Fcontribution-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjdennes%2Fcontribution-checker/lists"}