Git hours

Estimate time spent on a git repository.

For example time spent on Twitter's Bootstrap

➜  bootstrap git:(master) git hours
{
  "total": {
    "hours": 6345,
    "commits": 9705
  }
}

From a person working 8 hours per day, it would take more than 3 years to build Bootstrap.

How it works

The algorithm for estimating hours is quite simple.

Go through all commits and compare the difference between them in time.

If the difference is smaller or equal then a given threshold, group the commits to a same coding session.

If the difference is bigger than a given threshold, the coding session is finished.

To compensate the first commit whose work is unknown, we add extra hours to the coding session.

Continue until we have determined all coding sessions.

The algorithm in ~30 lines of code.

Install

$ npm install -g nodegit
$ npm install -g git-hours

Nodegit library is a bit unstable and might crash randomly.

Quick setup with Vagrant

Vagrant can be used to automatically set up a disposable Virtual Machine with the required environment and install the program.

$ git clone https://github.com/kimmobrunfeldt/git-hours
$ cd git-hours
$ vagrant up && vagrant ssh

And that's it, you can now test out git-hours. For example:

$ git clone https://github.com/twbs/bootstrap
$ cd bootstrap
$ git hours
{
  "total": {
    "hours": 6417,
    "commits": 9779
  }
}

Then when you are done playing around you can cleanly remove the vm from your system by running:

$ exit
$ vagrant destroy -f

Usage

In root of a git repository run:

$ git hours

Note: repository is not detected if you are not in the root of repository!

Help

Usage: git hours [options]

Options:

  -h, --help                                 output usage information
  -V, --version                              output the version number
  -b, --branches [branches]                  list of branches to calculate commits from e.g. master,dev. Default: all local branches
  -d, --max-commit-diff [max-commit-diff]    maximum difference in minutes between commits counted to one session. Default: 120
  -a, --first-commit-add [first-commit-add]  how many minutes first commit of session should add to total. Default: 120

Examples:

 - Estimate hours of project

     $ git hours

 - Estimate hours of development branch

     $ git hours --branches development

 - Estimate hours in repository where developers commit more seldom: they might have 4h(240min) pause between commits

     $ git hours --max-commit-diff 240

 - Estimate hours in repository where developer works 5 hours before first commit in day

     $ git hours --first-commit-add 300

For more details, visit https://github.com/kimmobrunfeldt/git-hours

For contributors

Documentation for git-hours developers.

Release

• Commit all changes

• Run grunt release, which will create new tag and publish code to GitHub

• Edit GitHub release notes

• Release to NPM

    $ git checkout x.x.x
    $ npm publish
  

To see an example how to release minor/major, check https://github.com/geddski/grunt-release

Test

Tests can be run with command

$ grunt test

or

$ npm test

You need to have mocha installed globally with npm install -g mocha.