You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -412,7 +412,7 @@ To maintain high quality in our codebase, we use structured **Issue Templates**
412
412
-**🐛 Bug Report Template**: For reporting visual glitches, API errors, or unexpected behavior.
413
413
-**✨ Feature Request Template**: For suggesting new isometric monolith designs, themes, or time/accuracy improvements.
414
414
415
-
By using these templates, you provide maintainers with clear details and context. Since you authored the issue, you can immediately claim it for yourself by commenting `/claim`! (Note: Issues authored by `jhasourav07` can be claimed by anyone).
415
+
By using these templates, you provide maintainers with clear details and context. Since you authored the issue, you can immediately claim it for yourself by commenting `/claim`! (Note: Issues authored by `jhasourav07` can be claimed by anyone immediately. Additionally, if an issue is opened by anyone other than `jhasourav07` or `aamod007`, is older than 1 week, and has no assignees, any contributor can claim it).
416
416
417
417
### 🔍 Semantic Duplicate Detection
418
418
@@ -427,13 +427,13 @@ To help maintainers keep the repository organized and prevent multiple contribut
427
427
428
428
Our automation runs entirely through issue comments. Here is how you interact with it:
|`/claim`|**Issue Author (or Anyone if authored by jhasourav07, or Anyone if older than 1 week with no assignees)**| Self-assigns the issue to you. |
433
+
|`/unclaim`|**Assigned Contributor**| Removes the assignment from yourself (opens it back up). |
434
+
|`/addlabel <label1> <label2>`|**Anyone**| Adds labels to the issue (e.g. `/addlabel frontend bug`). |
435
+
|`/unassign @username`|**Maintainers Only**| Removes the assignee from an issue. |
436
+
|`/assign @username`|**Maintainers Only**| Manually assigns someone to an issue. |
437
437
438
438
### ⏳ The Inactivity Policy (Assignment Expiry)
439
439
@@ -458,7 +458,7 @@ If the bot rejects your command, check these common scenarios:
458
458
-**"Commands cannot be used on closed issues"**: You cannot claim, assign, or unassign on closed issues. Find an open one!
459
459
-**"You already have X/5 active assigned issues"**: You have reached the maximum of 5 concurrent assignments. Finish one of your current tasks before claiming a new issue. If you're stuck, use the `/unclaim` command to unassign yourself from an issue, or ask a maintainer to `/unassign` you.
460
460
-**"This issue is already assigned to @username"**: Be faster next time! Look for issues without assignees.
461
-
-**"Only the author of this issue can claim it"**: You tried to `/claim` an issue you did not create. You can only claim issues that you authored (unless the issue was authored by `jhasourav07`, which anyone can claim).
461
+
-**"Only the author of this issue can claim it"**: You tried to `/claim` an issue you did not create. You can only claim issues that you authored (unless the issue is older than 1 week with no assignees, or was authored by `jhasourav07`, which anyone can claim).
462
462
-**"The following label(s) do not exist"**: You can only add existing repo labels. The bot will reply with a list of valid labels you can use.
463
463
-**"You don't have permission"**: You tried to use `/assign` or `/unassign`. Please use `/claim` instead.
|`cyberpunk_neon`| Electric cyan neon |`0d0d14`|`ff0055`|`00f3ff`|
155
+
|`enterprise`| Professional indigo dark |`1a1a2e`|`6366f1`|`e2e8f0`|
142
156
143
157
> **`auto` uses CSS `@media (prefers-color-scheme)`** inside the SVG so the badge switches between the `light` and `dark` palettes based on the viewer's OS setting — no JavaScript required. This is ideal for GitHub profile READMEs where visitors may use either mode.
144
158
145
159
For all URL parameters and configuration possibilities (including grace periods, custom fonts, timezone overrides, versus comparison mode, heatmap view, LOC mode, and layout dimensions), check out the **[🎨 Customization Guide & Parameters](docs/customization.md)**.
146
160
161
+
For advanced usage examples including custom gradient backgrounds, multi-user comparisons, organization dashboards, and custom date ranges, see the **[🚀 Advanced Usage Examples](docs/customization.md#-advanced-usage-examples)** section in the customization guide.
162
+
147
163
---
148
164
149
165
## ✨ Features
150
166
151
167
CommitPulse transforms GitHub contribution data into visually engaging and highly customizable SVG badges.
-**🎵 Spotify "Currently Playing"**: Showcase your current Spotify playback on your GitHub profile with a customizable, near real-time SVG card.
154
171
-**📈 Contribution Analytics**: Current streak and longest streak tracking, monthly contribution summaries, historical year-by-year viewing, and custom grace period configurations.
155
172
-**🔥 Visualization Modes**: Isometric 3D monolith rendering (with ghost city blueprint foundations), GitHub-style heatmap, monthly statistics view, and radar chart view.
156
173
-**🌍 Localization & Accessibility**: Multi-language support (e.g. English, Hindi, Simplified Chinese, Portuguese), timezone-aware calculations, and high-contrast accessibility themes.
@@ -166,6 +183,7 @@ To keep the repository clean and readable, technical details have been modulariz
166
183
-**[🎨 Customization Guide & Parameters](docs/customization.md)**: Explore the list of over 30 URL parameters including `theme`, `view` (e.g. `skyline`, `heatmap`, `radar`, `monthly`), `radius`, `grace`, `tz`, `entrance`, `versus`, and layout dimensions to style your monolith.
167
184
-**[🏛️ Architecture & Design Philosophy](docs/architecture.md)**: Read about why we built isometric 3D monolith landscapes instead of flat meters, and check out our Next.js 16 Edge computing pipeline.
168
185
-**[🚀 Self-Hosting & Deployment](docs/self_hosting.md)**: Step-by-step instructions to clone, configure `.env.local` with GitHub Personal Access Tokens (PAT), set up MongoDB tracking, and deploy to Vercel with one click.
186
+
-**[🎵 Spotify Setup Guide](docs/SPOTIFY_SETUP.md)**: Instructions for setting up Spotify integration for the Currently Playing feature.
169
187
-**[🤖 Automated Contributor Workflow](docs/contributor_workflow.md)**: Overview of GSSoC contribution automation, self-claiming comments `/claim`, anti-hoarding rules, stale unassign scripts, and Gemini AI-powered semantic issue duplication check.
170
188
-**[🎯 Real-Time Accuracy & Caching](docs/accuracy.md)**: Deep dive into the "off-by-N contributions" problem and how CommitPulse solves it with UTC midnight CDN expiration and no-store GraphQL fetches.
171
189
-**[❓ FAQ & Troubleshooting](docs/faq.md)**: Answers to common questions regarding timezone overrides, private contribution visibility, GitHub API rate limits, and troubleshooting.
0 commit comments