gitpair

gitpair

When pair programming or mob programming on git projects, there is a convention that allows us to document our co-authors in the commit message. However, adding the co-authorship information on every single commit is painful.

Gitpair allows you to setup your team members and commit as normal. It then amends your commit to add your co-authors.

Each author will randomly be credited either as the main author or one of the co-authors, 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!

Setup

First, install gitpair:

npm i -g gitpair

Add all your co-authors in a .gitpair/authors.json file higher up in directory tree (e.g. user's home folder), for instance:

[
  {
    "name": "Peter Yarrow",
    "email": "[e-mail]",
    "aliases": ["peter"]
  },
  {
    "name": "Paul Stookey",
    "email": "[e-mail]",
    "aliases": ["paul"]
  },
  {
    "name": "Mary Travers",
    "email": "[e-mail]",
    "aliases": ["mary"]
  }
]

Add your pairs

Say you're doing some mob programming with Peter, Paul and Mary:

gitpair with peter paul mary

Then commit your work

$ commit -am "Too much of nothing"

This will result in the following commit:

Author:     Mary Travers <[e-mail]>

    Too much of nothing

    Co-authored-by: Paul Stookey <[e-mail]>
    Co-authored-by: Benoit d'Oncieu <[e-mail]>
    Co-authored-by: Peter Yarrow <[e-mail]>

Every commit will randomly switch author and co-authors.

Installation with husky

$ npm install --save-dev gitpair husky

Then update your package.json to run the hook script:

{
  ...
  "husky": {
    "hooks" {
      "post-commit": "gitpair amend"
    }
  }
}