https://github.com/inverse/git-pair
A tool to make it easier for git based pairing for co-authoring commits
https://github.com/inverse/git-pair
git mob-programming mobbing paired-programming pairing
Last synced: 12 months ago
JSON representation
A tool to make it easier for git based pairing for co-authoring commits
- Host: GitHub
- URL: https://github.com/inverse/git-pair
- Owner: inverse
- License: mit
- Created: 2023-05-12T21:32:46.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T03:52:11.000Z (about 1 year ago)
- Last Synced: 2025-03-25T08:42:38.548Z (about 1 year ago)
- Topics: git, mob-programming, mobbing, paired-programming, pairing
- Language: Go
- Homepage:
- Size: 218 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# git-pair
[](https://github.com/inverse/git-pair/actions/workflows/ci.yml)
A tool to make it easier for git based pairing for co-authoring commits.
It leverages the template feature of git by allowing you to easily managed repo scoped templates of co-authors.
## Installation
### MacOS
```bash
brew install inverse/homebrew-tap/git-pair
```
### Arch:
```bash
yay -S git-pair-bin
```
### APT based distro:
Add the following to a new file called `/etc/apt/sources.list.d/inverse-fury.list`
```
deb [trusted=yes] https://apt.fury.io/inverse/ /
```
And then install:
```bash
apt-get update && apt-get install git-pair
```
### For RPM based distro:
Add the following to a new file called `/etc/yum.repos.d/inverse-fury.repo`
```
[fury]
name=Inverse Private Repo
baseurl=https://yum.fury.io/inverse/
enabled=1
gpgcheck=0
```
And then install:
```bash
dnf install git-pair
```
Binaries are also distributed in the [releases](https://github.com/inverse/git-pair/releases) page. Simply download the archive for your architecture and unpack and add the binary to your path.
## Usage
By default the tool will look up commit authors from the git history of the repo you are in. However, you can also maintain a list of authors within your home
directory in a file called `~/.contributors.txt`. This file uses the `Name ` format.
To get started run `git-pair [s]tart`, selecting the contributors for the pairing session.
You can find out the current state of contributors running `git-pair [i]nfo`.
One you are done with that pairing session just run `git-pair [e]nd`.
_Note: Sessions are scoped to git repositories by leveraging commit templates._
## Developing
Built using [`mise`](https://github.com/jdx/mise) for managing required development dependencies.
### Building
```bash
task build
```
And you'll find the binary for your architecture in the `dist/` directory.
### Format
```bash
task format
```
### Lint
```bash
task lint
```