Drop this into your GitHub profile README and stop being boring.
Transform your GitHub contribution history into a cinematic 3D monolith.
|
|
|
|
To keep this guide concise and easy to read, we have modularized our technical documentation. Click any of the links below to access detailed guides and resources:
- 🎨 Customization Guide & Parameters: Explore the list of over 30 URL parameters including
theme,radius,grace,tz,entrance,versus, and layout dimensions to style your monolith. - 🏛️ Architecture & Design Philosophy: Read about why we built isometric 3D monolith landscapes instead of flat meters, and check out our Next.js 16 Edge computing pipeline.
- 🚀 Self-Hosting & Deployment: Step-by-step instructions to clone, configure
.env.localwith GitHub Personal Access Tokens (PAT), set up MongoDB tracking, and deploy to Vercel with one click. - 🤖 Automated Contributor Workflow: Overview of GSSoC contribution automation, self-claiming comments
/claim, anti-hoarding rules, stale unassign scripts, and Gemini AI-powered semantic issue duplication check. - 🎯 Real-Time Accuracy & Caching: Deep dive into the "off-by-N contributions" problem and how CommitPulse solves it with UTC midnight CDN expiration and no-store GraphQL fetches.
- ❓ FAQ & Troubleshooting: Answers to common questions regarding timezone overrides, private contribution visibility, GitHub API rate limits, and troubleshooting.
CommitPulse is an open project built for the Web3 and open-source community. Whether you want to design a new theme, refine the isometric geometry, or improve timezone edge cases — you are welcome here.
Read the full guide: CONTRIBUTING.md
MIT © Sourav Jha
- Sourav Jha (@jhasourav07) - LinkedIn
- Aamod Kumar (@Aamod007) - LinkedIn
For details on the project leads and roles, please see MAINTAINER.md.
Browse theme previews here: Theme Gallery
Built with obsession, shipped with precision.
⭐ If CommitPulse made your profile look elite, drop a star. ⭐
Thanks to all contributors who have helped make CommitPulse better!
View the full contributor list →