A GitHub badge service displaying repository rating - Proof of Concept!
Ruby HTML CSS Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
lib
log
public
spec
vendor/assets
.gitignore
.rspec
.ruby-version
.travis.yml
Gemfile
Gemfile.lock
Guardfile
LICENSE
Procfile
README.md
Rakefile
app.json
config.ru

README.md

Haz Commitz?! GitHub repository rating service

Build Status Code Climate Coverage Status Haz Commitz Status

A GitHub badge service displaying repository rating

Having trouble deciding whether to use an open source project? Frustrated at having to check whether the project has had any commits recently, is it still maintained? Should you use it?

If the repository were to use a Haz Commitz badge then just a simple glance at the badge will give an indication whether the project is actively maintained based on the rating.

Experitmental proof of concept project - may get trashed at any point.

Check it out now

Usage

Project owner

Simply just add a Haz Commitz badge to your repository README, we take care of the rest by checking your project and serving a badge based on a rating.

Markdown

[![Haz Commitz Status](http://haz-commitz.herokuapp.com/repos/{owner}/{repository}.svg)](http://haz-commitz.herokuapp.com/repos/{owner}/{repository})

RDOC

{<img src="http://haz-commitz.herokuapp.com/repos/{owner}/{repository}.svg" alt="Haz Commitz Status" />}[http://haz-commitz.herokuapp.com/repos/{owner}/{repository}]

HTML

<img src="http://haz-commitz.herokuapp.com/repos/{owner}/{repository}.svg" alt="Haz Commitz Status" />

Access your repository stats via a URL like http://haz-commitz.herokuapp.com/repos/{owner}/{repository}.

Project user

Checkout the repository's Haz Commitz badge and make a judgment.

Click the badge and come through to our site for some more info about the repository and how we have rated it.

Do you want to use a repository that has not had any commits in 2 years? Maybe. Or maybe not depending on the repo and use case.

How we work out the rating

In the proof of concept version we currently use two factors:

  • A rating from the last commit date to master
  • The number of commits to master in the past six months
  • The number of stars the repository has received

Very un-scientific rating based on this data but we would add more factors in future.

Build, Test, & Run

Project is just a simple Rails app and uses Octokit gems currently.

$ bundle install

Test it with Rspec.

$ rspec

Run it.

$ foreman start

Run it anywhere you can run Rails applications, for example Heroku - checkout Procfile.

It needs an environment variable containing a GitHub API OAuth token.

$ heroku config:set GITHUB_TOKEN=<API TOKEN HERE>
$ git push heroku master

Contributions

Please use the GitHub pull-request mechanism to submit contributions.

License

This project is available for use under the MIT software license. See LICENSE