|
1 | | -𝐃𝐨 𝐍𝐨𝐭 𝐃𝐞𝐥𝐞𝐭𝐞 𝐓𝐡𝐢𝐬 𝐑𝐞𝐩𝐨𝐬𝐢𝐭𝐨𝐫𝐲! |
2 | | -Because the Contribution Graph was going to be reseted! |
| 1 | +# Contribution Graph Generator |
3 | 2 |
|
4 | | -Update VSC Files On GitHub: |
| 3 | +Professional Node.js automation system that generates realistic GitHub contribution graphs programmatically. |
5 | 4 |
|
| 5 | +## Overview |
6 | 6 |
|
7 | | -git add . |
8 | | -git commit -m "Commit Message" |
9 | | -git push origin main |
| 7 | +This repository provides a production-ready automation script designed to simulate authentic GitHub activity patterns across an entire year. |
| 8 | +It intelligently distributes commits based on seasonal trends, weekends, and configurable activity ratios — creating natural, human-like commit graphs. |
| 9 | + |
| 10 | +## Features |
| 11 | + |
| 12 | +- **Realistic Commit Patterns** – Seasonal behavior with active weekdays and light summer activity |
| 13 | +- **Year Configuration** – Generate commits for any selected year |
| 14 | +- **Smart Scheduling** – Pushes progress weekly or on Sundays |
| 15 | +- **Fully Automated** – Requires only one command to generate all commits |
| 16 | +- **Professional Documentation** – Complete setup, configuration, and security guidance |
| 17 | + |
| 18 | +> [!TIP] |
| 19 | +> All generated commits are timestamped for authenticity and automatically pushed to the selected Git branch. |
| 20 | +
|
| 21 | +## Quick Start |
| 22 | + |
| 23 | +```bash |
| 24 | +# Clone the repository |
| 25 | +git clone https://github.com/yourusername/contribution-graph.git |
| 26 | +cd contribution-graph |
| 27 | + |
| 28 | +# Install dependencies |
| 29 | +npm install |
| 30 | + |
| 31 | +# Configure project |
| 32 | +nano config.js |
| 33 | + |
| 34 | +# Generate commits |
| 35 | +npm run generate |
| 36 | +```` |
| 37 | + |
| 38 | +> [!WARNING] |
| 39 | +> Ensure your Git repository is initialized and connected to a remote before running the generator. |
| 40 | +> Running this script modifies your commit history. |
| 41 | + |
| 42 | +## Configuration |
| 43 | + |
| 44 | +Edit `config.js` to define: |
| 45 | + |
| 46 | +* **year:** The target year for commit generation |
| 47 | +* **targetCommits:** Approximate number of commits for the year |
| 48 | +* **activeDaysPercentage:** Probability of active days (0–1 range) |
| 49 | +* **pushOnSunday:** Whether to automatically push on Sundays |
| 50 | + |
| 51 | +Example: |
| 52 | + |
| 53 | +```js |
| 54 | +export const CONFIG = { |
| 55 | + year: 2025, |
| 56 | + targetCommits: 1000, |
| 57 | + activeDaysPercentage: 0.7, |
| 58 | + pushOnSunday: true |
| 59 | +}; |
| 60 | +``` |
| 61 | + |
| 62 | +## Documentation |
| 63 | + |
| 64 | +* [**Setup Guide**](docs/SETUP_GUIDE.md) – Complete installation and usage instructions |
| 65 | +* [**Troubleshooting**](docs/TROUBLESHOOTING.md) – Common errors and resolutions |
| 66 | +* [**Eligibility**](docs/ELIGIBILITY.md) – Requirements for commit simulation and contribution visibility |
| 67 | + |
| 68 | +## Requirements |
| 69 | + |
| 70 | +* **Node.js** v16.0 or higher |
| 71 | +* **Git** installed and configured |
| 72 | +* **Internet connection** for pushing commits |
| 73 | + |
| 74 | +## License |
| 75 | + |
| 76 | +This project is licensed under the [MIT License](LICENSE). |
| 77 | + |
| 78 | +> [!NOTE] |
| 79 | +> Contribution Graph Generator is an educational tool designed for learning Git automation and scripting techniques. |
0 commit comments