README.md in pair_see-0.1.5 vs README.md in pair_see-0.1.6

- old
+ new

@@ -13,28 +13,46 @@ * 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) +$ pairsee --after 2012-07-10 --config ../../foo/config/config.yml +$ pairsee --extras +$ pairsee --cards ``` ``` 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 + -c, --config=<s> location of config file, example: ../../config/config.yml (default: config/config.yml) + -a, --after=<s> Date since which you want to get commits, in yyyy-mm-dd format (default: 0-1-1) + -e, --extras See all commits without the name of any dev in them + -l, --latest See dates of most recent commits by pairs + -r, --recommended See active devs who have not paired (and therefore should) + -d, --cards See cards and number of commits on each + -s, --cards-by-commits This goes with --cards and sorts by number of commits instead of active card days + -p, --cards-per-person See cards for each dev + -k, --knowledge-debt Knowledge debt (cards that only one person worked on) + -m, --my-pairs Most recent dates of pairing for user + -h, --help Show this message + ``` +Example config file (see also config/config.yml.sample) +``` +names: + - Person1 + - Person2 + - ManyNamesPerson mnperson mprss +card_prefix: + - FOO- + - BAR- +roots: + - /Users/foo/repo1/ + - /Users/foo/repositories/repo2 + - /Users/foo/repositories/baz/repo3 +``` + to put on path: ``` cd pairSee ln -s `pwd`/bin/pairsee ~/bin/pairsee ``` @@ -44,44 +62,18 @@ 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` -## Installation -Add this line to your application's Gemfile: - -```ruby -gem 'pair_see' -``` - -## Usage - -See example repo https://github.com/compwron/example_pair_see_use - ## 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](https://rubygems.org). + +``` +rubocop --auto-correct +rubocop --auto-gen-config +```