PairSee

Code Climate Test Coverage Build Status Dependency Status

Usage cases:

  • See commit count for all devs and solo devs (in order by # of commits): $ pairsee --after 2012-10-01
  • See what cards have been in play and for how long since given date: $ pairsee --cards --after 2012-10-01
  • See all devs and what cards they have worked on since given date: $ pairsee --after 2013-11-01 -s

Example usage:

$ pairsee --root ../../my_code --after 2012-07-10 --config ../../foo/config/config.yml
$ pairsee --extras --root ../../my_code
$ pairsee --latest --after 2012-09-01 # this outputs pairings by most recent by all devs who have committed since given date (purpose of this is to exclude people who are no longer committers)
Options:
          --root, -r <s>:   Folder in which .git folder is (default: .)
        --config, -c <s>:   location of config file, example: ../../config/config.yml (default: bin/pairsee/../../config/config.yml)
         --after, -a <s>:   Date since which you want to get commits, in yyyy-mm-dd format (default: 0-1-1)
            --extras, -e:   See all commits without the name of any dev in them
            --latest, -l:   See dates of most recent commits by pairs
       --recommended, -o:   See active devs who have not paired (and therefore should)
             --cards, -d:   See cards and number of commits on each
  --cards-per-person, -s:   See cards for each dev
              --help, -h:   Show this message

to put on path:

cd pairSee
ln -s `pwd`/bin/pairsee ~/bin/pairsee

Run tests:

rspec
# or
rake_commit

Config file: config/config.yml contains names and card prefix, a la

names: Person1 Person2 Person3
card_prefix: FOO-

So if your commit log looks like

"Bob/Alice [FOO-1] wrote code"
"Alice [FOO-1] stuff"
"Sarah|Alice [FOO-2] code and stuff"

Then your config file will look like:

names: Bob Alice Sarah
card_prefix: FOO-

To use PairSee with SVN, check out SVN codebase with git like: git svn clone http://svn.example.com/project

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/pair_see. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

gem framework rename

Installation

Add this line to your application's Gemfile:

<<<<<<< HEAD
gem 'pairSee'
=======
gem 'pair_see'
>>>>>>> gem framework rename

And then execute:

$ bundle

Or install it yourself as:

<<<<<<< HEAD

$ gem install pairSee

$ gem install pair_see

gem framework rename

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.