shōmei

shōmei (証明) is a command-line interface (CLI) tool designed to enhance the visibility of developer contributions on GitHub, addressing the common issue of portraying an inactive profile due to work-related commits made with a different email account. The name "shōmei" translates to "proof" in Japanese, reflecting the tool's purpose of providing proof that actual work was done, even if it doesn't appear on a personal GitHub profile.

Problem Overview

Many developers utilize separate email addresses for their work-related projects and often face the challenge of their GitHub contribution graphs appearing inactive when job searching. This can lead to misunderstandings from recruiters who may not recognize that developers have been actively working from another account. shōmei provides a solution to this problem by mirroring corporate commits to a personal GitHub account without compromising proprietary information.

Key Features

• Zero IP Leakage: Ensures that no proprietary code leaves the original repository by creating empty commits with just timestamps.
• User-Friendly: Designed for ease of use, requiring only a single command to mirror contributions.
• Contribution Proof: Updates the GitHub contribution graph to accurately reflect the developer's activity.
• Email Filtering: Only commits associated with the specified email address are included, preserving the integrity of others' work.
• Dry-Run Mode: Allows users to preview the changes before committing, ensuring transparency.
• Private Repositories: Offers an option to mirror to a private repository if desired.

How It Works

1. Scans Git Log: The tool examines the git log for commits associated with the user's specified email.
2. Extracts Dates: Only the commit dates are extracted, keeping all other details private.
3. Creates a Repository: A new repository is generated on the user's personal GitHub account.
4. Uses GitHub API: The API is leveraged to create empty commits reflecting the extracted dates.
5. Generates a README: A README file is automatically generated for the mirrored repository.
6. Contribution Graph Update: The result is a contribution graph that accurately depicts the user's real work activity.

Important Note: Throughout this process, no actual code or sensitive information from the original repository is transmitted, ensuring company IP remains secure.

Getting Started

To utilize shōmei, install it via Python's package manager:

pip install shomei

Then, navigate to the repository where contributions were made and run

shomei

Follow the prompts to input your personal GitHub username and access token, and within minutes, the contribution graph will update to reflect your actual work responsibilities.

shōmei serves as a valuable tool for developers aiming to enhance their professional profiles by accurately showcasing their contributions across multiple accounts without risking the integrity of their corporate work.