GCommit - Group Commit

GCommit is a git-plugin that eases how to commit when you need to sign for more than one person -- pair and mob programming reality.

Instead of having to set manually the other developers names, you can define once and reference at any commit-time.

Installation

For installation you have to run the next command:

$ sudo make install

GCommit has been installed successfully

Uninstall

For Uninstallation you have to run the next command:

$ sudo make uninstall

How to use

GCommit reads a file that defines your teammates signatures, so first create a .gitteam file in your project's root directory, that follows the following structure:

JD="João Daniel <jotaf.daniel@gmail.com>"
JOD="John Doe <jon.doe@example.com>"
JAD="Jane Doe <jane.doe@example.com>"

note: there's no empty line at the end

Once you have .gitteam in your repository, you can commit something using:

git gcommit JAD JD

This will generate a initial commit message like this:

Signed-off-by: Jane Doe <jane.doe@example.com>
Signed-off-by: João Daniel <jotaf.daniel@gmail.com>

To pass other git commit command line arguments to GCommit we would have to do the following :

git gcommit JAD JD --amend

where --ammend is an argument for git commit

To add all the members of your team to the commit, you can use the following command

git gcommit --all

To remove particular members from a commit

git gcommit --except JAD

This command would remove JAD and adds all others to the commit list.

Contributing

Please refer to CONTRIBUTING.md

Contributors

Many thanks to all contributors!

License

This project is licensed under the MIT License