https://github.com/mtfoley/test-sync-contribution-graph

https://github.com/mtfoley/test-sync-contribution-graph

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mtfoley/test-sync-contribution-graph
• Owner: mtfoley
• License: mit
• Created: 2021-12-15T03:37:22.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-15T03:37:23.000Z (about 3 years ago)
• Last Synced: 2024-10-26T07:24:14.539Z (2 months ago)
• Language: JavaScript
• Size: 380 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  Sync Contribution Graph



![GitHub Contributions Graph full squares that have various shades of green](img/cover-photo.png)



    



## How to Use 🚀

1. [Create a new repo](https://github.com/new) and [clone it](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) on your local machine.

   > **Note:** You can't simply fork this repository because none of the commits will count toward the contribution graph.

   [More info here](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/why-are-my-contributions-not-showing-up-on-my-profile#issues-pull-requests-and-discussions).

2. Clone this project locally and copy/paste it's contents into the repo you just created.

3. Run `npm i` in your terminal.

4. Use `run start` in order to trigger a series of terminal prompts that will help with configuration.

   > On Windows, please run it from Git Bash.

If you change your mind about these commits later, you can delete the repository and they'll disappear from your contribution graph.



## Requested Information 🌳

| Key        | Description                                                                                                                                                 | Default value                                        |

| ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |

| `username` | The username whose graph contributions you'd like to copy.                                                                                                  |                                                      |

| `year`     | Year that you would like to sync with provided `username`. Currently doesn't support multiple years.                                                        | Current year                                         |

| `execute`  | Let's the code know whether to simply generate `script.sh` that, when executed, will force push commits to `main`. Or to both generate and execute at once. | `false`, in other words generate _without_ execution |

| `confirm`  | A quick double check that you're ready to proceed.                                                                                                          |

## How do I know this is secure? 🔒

Explore the [code](src/index.js)! It's tiny and there aren't many dependencies.

It only scrapes publicly available data from existing GitHub contribution graphs. It does not have access to private commits or issues created. So I can promise that you will not get in trouble for syncing your personal and work GitHub graphs considering there isn't any private company code being exposed!

## On Project's Future ✨

There's a lot of potential features and automations that could be added! Something as basic as accepting multiple years to pull at once, or more complicated like having a GitHub Action that once per month/year/time period creates a PR with newer commits, making it effortless to keep them synced.

## Contribute 👪

PRs are welcome! One day I'll probably write a Contributing guide. This project is [MIT](LICENSE) licensed.