contribution

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #go #golang #android #rust #macos #windows #awesome #cli #vue #security #open-source

(★ 323)

CLI tool to draw an image on your GitHub contribution graph.

contribution Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Contribution

Draw an image on your GitHub contribution graph.

#### Examples

| ![Heart](https://raw.githubusercontent.com/blaise-io/contribution/master/image/result/heart.png)            | ![Skull](https://raw.githubusercontent.com/blaise-io/contribution/master/image/result/skull.png)            |
| ------------------------------------------- | ------------------------------------------- |
| ![Creeper](https://raw.githubusercontent.com/blaise-io/contribution/master/image/result/creeper.png)        | ![I need a job](https://raw.githubusercontent.com/blaise-io/contribution/master/image/result/ineedajob.png) |

## How does it work?

GitHub displays commits in the contribution history graph. Contribution pushes 
a bunch of commits with a custom date using `git commit --date <date>`. It 
bundles multiple commits on a single day to achieve a darker pixel in the graph.

The GitHub contribution graph is 52 × 7 pixels and shows up to five shades for
activity. This app automatically limits the colors and dimensions of your input 
image to match these restrictions. Use the [preview](#contribution-preview--help) 
subcommand if you're not feeling lucky.

Warning: you cannot remove contribution activity on GitHub unless you delete a 
project, so you probably want to push to a project specifically created for 
this purpose. Contributions to secret projects may also be shown, depending on 
your GitHub settings.

Contribution uses your default SSH settings and global Git user, which can be 
tested with `ssh -T git@github.com` and `git config --global user.email`. If you 
prefer to use another identity, set `GIT_SSH_COMMAND='ssh -i /other/id_rsa'` and 
`git config --global user.email "other@example.org"`.

## Download

You can find prebuilt binaries for Windows, macOS and Linux in 
[releases](https://github.com/blaise-io/contribution/releases/latest).

Or clone the project and build yourself.

- [Use the source image of these examples](image/source)
 - [Create your own using this palette image](image/source/palette.png)

If you don't have Paint installed you can use a free online tool like 
[pixilart.com](https://www.pixilart.com/draw).

## How to use

Contribution is provided as a binary with a command line interface.

### `contribution -help`
```
Draw an image on your GitHub contribution history.
By Blaise Kal, 2021

Preview contribution history graph without pushing
  contribution preview -img /path/to/image.png
Preview usage and options
  contribution preview -help

Push contribution history graph to GitHub
  contribution push -img /path/to/image.png -project username/project
Push usage and options
  contribution push -help
```

### `contribution preview -help`
```
Preview contribution history graph without pushing.
Example usage:
  contribution preview -img image.png

-img string
    	Path to a valid PNG image. (required)
```

### `contribution push -help`
```
Push contribution history graph to GitHub
Example usage:
  contribution push -project username/project

-branch string
    	Git branch to push to. (default "contribution")
  -img string
    	Path to a valid PNG image. (required)
  -project string
    	GitHub username/project to push to. (required)
  -w int
    	Weeks ago of all activity. A value of 2 will move activity two pixels to the left.
```

contribution

contribution Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

contribution

contribution Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README