sansyrox / git-add-co-author

Easily Credit Contributors in Git Commits

Git Add Co-Author

Demo

Overview

Git Add Co-Author is a simple Python script that allows you to easily add co-authors to your Git commits, ensuring proper credit is given to all contributors involved in the development process. This can be particularly useful for open-source projects, where multiple contributors are working together, or for pair programming sessions where two developers contribute to the same commit.

Installation

1. Install the package using pip:

pip install git-add-co-author

2. Obtain a personal access token from GitHub. You can generate one by following the instructions in the GitHub documentation.

3. Configure the script with your GitHub token:

python -m git_add_co_author --token <your_token>

Usage

To add a co-author to your commit, simply run the script with the co-author's GitHub username:

python -m git_add_co_author --username <co_author_username>

For example:

python -m git_add_co_author sansyrox

If you do not want to authorize a token, you can add the co-author's name and email address directly:

python -m git_add_co_author --name "John Doe" --email "[e-mail]"

Optional Configuration

I alias this command as alias gac="python -m git_add_co_author --username" in my .zshrc file, so I can simply run gac <co_author_username> to add a co-author to my commit.

Rationale

The motivation behind creating this script is to provide an easy way to give credit to contributors in various situations:

• In open-source projects, when a pull request (PR) is closed without merging but the idea or code is later implemented.
• During pair programming sessions, where two or more developers work together on a single commit.

Existing solutions were either too complicated or didn't work as expected, so Git Add Co-Author was developed as a simple, easy-to-use alternative.

License

This project is licensed under the MIT License.