by Andre Helberg (@A_Helberg)
Description:
Pair Up allows two developers to be jointly credited when Pair Programming and using Git.
Features:
- Persists pair between different terminal instances.
- Can be used in OSX GUI applications ( after restarting the application )
- Allows you to expire the pair information in N hours. e.g. pair --expire 8 fry leela
Why use Pair Up instead of other tools?:
Pair Up is based off the solid work of Hitch. Its main differentiating factor is that it picks one developer to be the author, and another to be the committer. Similar solutions create a dummy email account of all devs, which could potentially be more than two. Pair Up only allows two devs. One will be the author (usually the person that is driving) and the other is the committer. No extra email accounts or gravatar setups are required.
Installation & Usage:
Install the gem and add the setup to the end of your zshrc or bashrc file
$ gem install pair-up
$ pair --setup >> ~/.zshrc
Restart your terminal.
To pair with someone replace the following names with your github names
$ pair A-Helberg aleciafb
Now just commit as you usually would. If you use a gui application on OSX, remember to restart it when you setup a new pair or switch pairs for it to take effect. The first username will be used as the author and the second username as the committer.
To switch the pairs around run:
$ pair --switch
Don't forget to unpair when you are done:
$ pair -u
For some help and a complete list of features:
$ pair -h
Install:
gem install pair-up
pair --setup
- this prints out the necessary shell function and aliases you need to add to your ~/.bashrc or ~/.zshrc
- eg.
pair --setup >> ~/.zshrc
- eg.
- Or copy/paste the code into your ~/.bashrc or ~/.zshrc
- As another option, copy/symlink the script to a separate file (e.g.
~/.bash/pair-up.sh
or/etc/profile.d/pair-up.sh
) and source it. You can get the path usingpair --setup-path
. - Restart your terminal.
Development:
- Fork pair-up
- Add tests and code for your feature
- Create a pull request
- Double-check TravisCI to make sure all tests pass
Requirements:
- Git, HighLine
Acknowledgements:
- Rogelio J. Samour (http://blog.therubymug.com)
- Stephen Caudill
- Les Hill
- Tim Pope
License:
Released under the MIT License. See the LICENSE file for further details.