hegde5 / GCommit

GCommit is a git-plugin that eases pair-programming commits

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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>

Contributing

Please refer to CONTRIBUTING.md

Contributors

Many thanks to all contributors!

Name Photo
Mairieli Wessel Mairielli
Emmanuel Arias Emmanuel Arias
Gurkirpal Singh Gurkirpal Singh
Eloy Eloy
Thathiane Rosa Thathiane
Vinay Hegde Vinay Hedge
Andre Moukarzel Andre Moukarzel
Caio Andrade Caio Andrade
Pedro Pereira Pedro Pereira
Jay Welborn Jay Welborn

License

This project is licensed under the MIT License

About

GCommit is a git-plugin that eases pair-programming commits

License:MIT License


Languages

Language:Python 89.9%Language:Makefile 10.1%