GHat

README IN 中文

Overview

GHat (Github Hat Decorator/Green Hat Decorator) is a quick hack for decorating your GitHub contribution calendar with a specific date file. It uses the GIT_AUTHOR_DATE and GIT_COMMITTER_DATE environmental variables to make commits appear in the past. Be warned that GHat will clobber your repository's commit history. Therefore it's better for you to use it on a new repository.

Requirements

• Python 3.6+
• Works on Linux(not sure), Windows, macOS(not sure)

Install

The quick way:

pip install ghat

Or you can just put file ghat.py in your repository directory.

And use command python ghat.py instead of ghat.

Usage

Before you use it remember to check your git email address. It must be same with your email in github, otherwise all commits won't appear in the contribution calendar.

First cd to your repository directory.

Then you have 3 choices:

The simplest way is type "ghat" and follow the instructions:

ghat

Or you want initialize a new repository and make commit:

ghat -i your_repository_url /path/to/date.file

Or you want make commits on an existing repository:

ghat /path/to/date.file

Documentation

Still in writing...