Skip to content

docs(readme): add full query-param matrix with examples and defaults#747

Open
shanvi-jakhwal wants to merge 5 commits into
JhaSourav07:mainfrom
shanvi-jakhwal:main
Open

docs(readme): add full query-param matrix with examples and defaults#747
shanvi-jakhwal wants to merge 5 commits into
JhaSourav07:mainfrom
shanvi-jakhwal:main

Conversation

@shanvi-jakhwal
Copy link
Copy Markdown

@shanvi-jakhwal shanvi-jakhwal commented May 27, 2026

Description

Fixes #239

Pillar

  • 🎨 Pillar 1 — New Theme Design
  • 📐 Pillar 2 — Geometric SVG Improvement
  • 🕐 Pillar 3 — Timezone Logic Optimization
  • 🛠️ Other (Bug fix, refactoring, docs)

Visual Preview

Checklist before requesting a review:

  • [X ] I have read the CONTRIBUTING.md file.
  • I have tested these changes locally (localhost:3000/api/streak?user=YOUR_USERNAME).
  • I have run npm run format and npm run lint locally and resolved all errors (CI will fail otherwise).
  • My commits follow the Conventional Commits format (e.g., feat(themes): ..., fix(calculate): ...).
  • I have updated README.md if I added a new theme or URL parameter.
  • I have started the repo.
  • I have made sure that i have only one commit to merge in this PR.
  • The SVG output matches the CommitPulse "premium quality" aesthetic standard (no raw elements, smooth animations, correct fonts).
  • (Recommended) I joined the CommitPulse Discord community for contributor discussions, mentorship, and faster PR support.

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 27, 2026

@shanvi-jakhwal is attempting to deploy a commit to the jhasourav07's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Copy Markdown

👋 Hey @shanvi-jakhwal, welcome to CommitPulse! 🎉

Thanks for opening your first pull request — this is a big deal and we appreciate the effort!

While you wait for a review, please double-check:

  • ✅ You've read the CONTRIBUTING.md checklist
  • npm run lint, npm run format, and npm run test all pass locally
  • ✅ Your PR has a visual preview if it touches any SVG output
  • 💬 You've joined our Discord for faster PR feedback

A maintainer will review your PR shortly. Hang tight! 🚀

@github-actions
Copy link
Copy Markdown

👋 Hey @shanvi-jakhwal! Thanks for your contribution! 🎉

It looks like this PR isn't linked to any issue yet.

Please edit your PR description and add a closing keyword so we can track this properly, for example:

Fixes #<issue-number>

💡 You can link multiple issues if needed (e.g. Fixes #12, Closes #34).
If you're working on something that doesn't have an issue yet, please open one first and then link it here.

Once you've updated the PR description the check will re-run automatically. 🙌

@github-actions github-actions Bot added the status:blocked This PR is blocked due to a failing CI check. label May 27, 2026
@github-actions
Copy link
Copy Markdown

🚨 Hey @shanvi-jakhwal, the CI Pipeline is failing on this PR and it has been marked as status:blocked.

Please fix the issues before this can be reviewed. Here's how:

1. Run checks locally before pushing:

npm run format:check   # Check Prettier formatting
npm run lint           # Run ESLint
npm run typecheck      # TypeScript type check
npm run test           # Run unit tests (Vitest)
npm run build          # Verify production build passes

2. Auto-fix common issues:

npm run format         # Auto-fix formatting with Prettier
npm run lint -- --fix  # Auto-fix lint errors where possible

3. Check the full failure log here:
👉 View CI Run

Once you push a fix and the CI passes, the status:blocked label will be removed automatically. 💪

@shanvi-jakhwal
Copy link
Copy Markdown
Author

shanvi-jakhwal commented May 27, 2026

This is a docs-only README change. The CI Prettier check is failing due to markdown table formatting. Could a maintainer please run npm run format on the repo or override the status:blocked label?

@github-actions github-actions Bot removed the status:blocked This PR is blocked due to a failing CI check. label May 27, 2026
@JhaSourav07 JhaSourav07 added GSSoC 2026 level:beginner Small changes Usually isolated fixes or simple UI/text updates. quality:exceptional Outstanding contribution with exceptional implementation quality, testing. gssoc:approved PR has been reviewed and accepted for valid contribution points and removed gssoc:approved PR has been reviewed and accepted for valid contribution points labels May 27, 2026
@github-actions github-actions Bot added this to the GSSoC 2026 milestone May 27, 2026
@JhaSourav07
Copy link
Copy Markdown
Owner

you can run npm run format locally and push the commit to your PR branch

@JhaSourav07 JhaSourav07 removed the quality:exceptional Outstanding contribution with exceptional implementation quality, testing. label May 27, 2026
@github-actions github-actions Bot added type:docs Documentation changes, wikis, or README updates needs-rebase This PR has merge conflicts and needs a rebase. labels May 27, 2026
@github-actions
Copy link
Copy Markdown

⚠️ Hey @shanvi-jakhwal, this PR has merge conflicts with the main branch.

Please pull the latest changes and resolve the conflicts so we can review it!

git fetch origin
git rebase origin/main
# resolve any conflicts, then:
git push --force-with-lease

Once resolved, the needs-rebase label will be removed automatically on the next check. 🙌

1 similar comment
@github-actions
Copy link
Copy Markdown

⚠️ Hey @shanvi-jakhwal, this PR has merge conflicts with the main branch.

Please pull the latest changes and resolve the conflicts so we can review it!

git fetch origin
git rebase origin/main
# resolve any conflicts, then:
git push --force-with-lease

Once resolved, the needs-rebase label will be removed automatically on the next check. 🙌

@github-actions github-actions Bot added the status:blocked This PR is blocked due to a failing CI check. label May 28, 2026
@github-actions github-actions Bot removed the needs-rebase This PR has merge conflicts and needs a rebase. label May 28, 2026
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
@github-actions github-actions Bot removed the status:blocked This PR is blocked due to a failing CI check. label May 28, 2026
@shanvi-jakhwal
Copy link
Copy Markdown
Author

Hi @JhaSourav07! I've resolved the merge conflict, run npm run format, and pushed the changes. PR is ready for review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

GSSoC 2026 level:beginner Small changes Usually isolated fixes or simple UI/text updates. type:docs Documentation changes, wikis, or README updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(readme): add full query-param matrix with examples and defaults

2 participants