System Documentation

System Setup & Architecture Guide

Follow these two essential steps to ensure all generated commits accurately render on your public GitHub contribution graph.

1. Create a Dedicated Target Repository

Step 1

Recommended: 'gitcontra' or 'activity-history'

Create a new repository on your GitHub account (public or private). We recommend keeping it isolated in a dedicated repository rather than polluting production codebases.

Crucial Requirement: Check the box that says "Add a README file" so GitHub initializes the default branch tree.

2. Enable Private Contributions in Profile Settings

Step 2

Required if your target repository is Private

If your chosen target repository is private, GitHub hides private activity from public profile visitors by default. To make these squares visible:

  1. Open your GitHub Profile → click Settings.
  2. Scroll down to the Contribution & Activity section.
  3. Check the option: "Include private contributions on my profile".
  4. Click Update Preferences.
Cache Indexing Note: GitHub's background contribution cache can take anywhere from a few minutes to up to 24 hours to re-index historical backdated commits on your profile graph.