Skip to content

README.md

Latest commit

 

History

History
78 lines (54 loc) · 2.27 KB

README.md

File metadata and controls

78 lines (54 loc) · 2.27 KB

Contribution Graph Generator

Professional Node.js automation system that generates realistic GitHub contribution graphs programmatically.

Overview

This repository provides a production-ready script designed to simulate GitHub activity across an entire year.
It intelligently distributes commits based on trends and configurable ratios creating human-like graphs.

Features

  • Realistic Commit Patterns – Seasonal behavior with active weekdays and light summer activity
  • Year Configuration – Generate commits for any selected year
  • Smart Scheduling – Pushes progress weekly or on Sundays
  • Fully Automated – Requires only one command to generate all commits
  • Professional Documentation – Complete setup, configuration, and security guidance

Tip

All generated commits are timestamped for authenticity and automatically pushed to the selected Git branch.

Quick Start

# Clone the repository
git clone https://github.com/yourusername/contribution-graph.git
cd contribution-graph

# Install dependencies
npm install

# Configure project
nano config.js

# Generate commits
npm run generate

Warning

Ensure your Git repository is initialized and connected to a remote before running the generator.

Configuration

Edit config.js to define:

  • year: The target year for commit generation
  • targetCommits: Approximate number of commits for the year
  • activeDaysPercentage: Probability of active days (0–1 range)
  • pushOnSunday: Whether to automatically push on Sundays

Example:

export const CONFIG = {
  year: 2025,
  targetCommits: 1000,
  activeDaysPercentage: 0.7,
  pushOnSunday: true
};

Documentation

  • Setup Guide – Complete installation and usage instructions
  • Troubleshooting – Common errors and resolutions
  • Eligibility – Requirements for commit simulation and contribution visibility

Requirements

  • Node.js v16.0 or higher
  • Git installed and configured
  • Internet connection for pushing commits

Note

Contribution Graph Generator is an educational tool designed for learning Git automation and techniques.

License

This project is licensed under the MIT License.