This utility is designed to make it easier to add co-authors to your Git commits. It's a simple command-line tool that reads from a co-authors file and adds the appropriate co-author lines to your commit messages.
To install the Git Co-Author Utility, clone the repository and add the project directory to the PATH.
To use the Git Co-Author Utility, first create a co-authors file.
The utility expects this file to be present at ~/.gitauthors
or the path stored in the COAUTHORS_PATH
environment variable.
This file should be an INI file, with each co-author represented as a separate section. Here's an example:
[harry]
name = Harry Potter
email = [email protected]
[hermione]
name = Hermione Granger
email = [email protected]
[ron]
name = Ron Weasley
email = [email protected]
Then, when you're ready to commit, use the git coauthor command followed by the keys of the co-authors you want to add:
git coauthor -m "The commit message" -a harry -a hermione
This will add Harry and Hermione as co-authors to your commit.
For more information on the utility, consult the manual:
man git-coauthor
Contributions are welcome! Please submit a pull request or create an issue to discuss any changes you want to make.
This project is licensed under the MIT License. See the LICENSE file for more details.