gitpair

Gitpair

When pairing or doing mob programming on github projects, git does not allow us to commit with all the names of people who contributed. Gitpair allows you to setup your team members and commit as normal. It then changes your commit based on the list of people referenced in the commit message.

Each author will randomly be credited with commiter or authorship, so that we can each be credited in our github contributions view !

Before Gitpair :sob:

After Gitpair :heart_eyes:

Gitpair does not require you to change the way you commit. Simplify use the git commit command or your favorite tool!

Example:

The following two commits

$ commit -am "JBH|BDO|JON Added README file"

$ commit -am "@jordan @benoit @jonathan Added README file"

are equivalent and will result in the following commit:

commit 5aac6c15b7ea2b8ed6b8daaba01539931b9d9309
Author:     Jordan Bartholomew-Harrison, Benoit d'Oncieu and Jon McClennon <[e-mail]>
AuthorDate: Thu Oct 27 22:09:34 2016 +0200
Commit:     Jon McClennon <[e-mail]>
CommitDate: Thu Oct 27 22:09:34 2016 +0200

    BDO|JM: Added README file

The author's name contains the list of all author names while the author and committer emails will be randomly choosen amongst the list of committers. The commit message is normalised as a pipe separated list of initials followed by a dash.

Installation

Pre-requisites

A recent version of node and npm.

Install

$ npm install gitpair

The installation adds a post-commit hook at the root of your project in the .git/hooks directory.

Note: Do not install globally with npm install -g as it won't work :wink:

Configure

Create a .gitpair file in your user home folder. For instance:

{
  "team": [
    { "name": "Benoit d'Oncieu",             
      "aliases": ["bdo", "benoit"],
      "email": "[e-mail]" },
    { "name": "Jon McClennon",
      "aliases": ["jm", "jon", "jonathan", "jonathanmcclennon"],   
      "email": "[e-mail]" },
    { "name": "Jordan Bartholomew-Harrison", 
      "aliases": ["jbh", "jordan", "jordanbharrison"], 
      "email": "[e-mail]" }
  ]
}

Commit message patterns

You can use one of two styles of commit messages. The user names used must correspond to one of the aliases you listed in your .gitpair file (see above).

Github styled	Initials
@bdo @jon Added package.json	BDO|JON: Added package.json

Notes:

• The normalised format message will use the Initials pattern and the first alias for each author.
• When using the Initials flavor, the semicolon is optional.

Uninstall

$ npm uninstall gitpair

This removes the post-commit hook which was added during the install.