docs: add inline comments explaining GitHub API rate limiting

[sudha09-git]

---

Summary

Added inline comments to src/app/api/metrics/contributions/route.ts explaining how GitHub API rate limiting works, how it is detected, and what the user sees when limited.

Closes #93

---

Type of Change

• Bug fix
• New feature
• Documentation update
• Refactor / code cleanup

---

Changes Made

• Added top-level comment block explaining the two rate limit tiers (60 req/hr unauthenticated, 5,000 req/hr authenticated)
• Documented how the OAuth token / PAT in the Authorization header activates the higher limit
• Expanded the existing while loop comment to clarify HTTP 403 vs 429 and the X-RateLimit-Remaining: 0 header
• Added comment above the fetch call explaining why the Authorization header matters for rate limits
• Clarified the partial-results strategy — returning collected data on rate limit instead of failing the whole request
• Documented what the user sees when rate limited ("GitHub API error" in the dashboard)

---

How to Test

1. Open src/app/api/metrics/contributions/route.ts
2. Verify the top-level rate limit comment block appears before export const dynamic
3. Verify the while loop comment explains 403, 429, and X-RateLimit-Remaining
4. Verify the fetch call has an inline comment about the Authorization header
5. Confirm no logic was changed — only comments were added

---

---

Checklist

• Linked issue in summary
• npm run lint passes locally
• No TypeScript errors (npm run type-check)
• Self-reviewed the diff
• Added/updated tests if applicable

---

Accessibility Checklist

• Proper keyboard navigation tested
• Responsive UI verified
• Accessibility labels added where needed

---

[vercel]

@sudha09-git is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

[github-actions]

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — please apply the appropriate labels before merging:

Difficulty (pick one):

• level:beginner — 20 pts
• level:intermediate — 35 pts
• level:advanced — 55 pts
• level:critical — 80 pts

Quality (optional):

• quality:clean — ×1.2 multiplier
• quality:exceptional — ×1.5 multiplier

Validation (required to score):

• gssoc:approved — counts for points
• gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

[sudha09-git]

Hi @Priyanshu-byte-coder

All 9 CI checks are now passing . This PR adds inline comments to src/app/api/metrics/contributions/route.ts explaining the GitHub API rate limiting behavior (60 req/hr unauthenticated vs 5,000 req/hr with Authorization header).

Would love to get your review when you get a chance. Thanks!

[github-actions]

🎉 Merged! Thanks for contributing to DevTrack.

If the project has been useful to you, a ⭐ star on the repo is the easiest way to support it — it helps DevTrack get discovered by more developers.

Keep an eye on open issues for your next contribution!