Skip to content

feat: add README Insight compact card in Generator section#6097

Closed
RosheshChaware wants to merge 1 commit into
JhaSourav07:mainfrom
RosheshChaware:feat-readme-insight
Closed

feat: add README Insight compact card in Generator section#6097
RosheshChaware wants to merge 1 commit into
JhaSourav07:mainfrom
RosheshChaware:feat-readme-insight

Conversation

@RosheshChaware

Copy link
Copy Markdown
Contributor

Description

Fixes #6095

This PR adds a new compact UI widget called README Insight inside the Generator section below the “README Health Breakdown” card.

The widget improves dashboard completeness by utilizing the previously empty space and provides quick actionable README improvement tips in a minimal, dark-theme compatible design.

Features added:

  • Small card titled README Insight
  • Displays a single dynamic tip from a static list:
    • Add badges for credibility
    • Improve description clarity
    • Add installation steps
    • Include social links
  • Shows a small badge: Health Boost +X%
  • Lightweight hover/fade animation (optional)
  • Fully UI-only implementation (no logic/backend changes)

No existing components were modified.

Pillar

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

Visual Preview

Screenshot 2026-06-20 215303

Checklist before requesting a review:

  • 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: add README Insight card).
  • I have updated README.md if required.
  • I have started the repo.
  • I have made sure that I have only one commit to merge in this PR.
  • The UI output matches the CommitPulse aesthetic standard (clean, minimal, smooth).
  • I have ensured no backend/API changes were made.

@vercel

vercel Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Someone 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
Contributor

👋 Hey @RosheshChaware! Thanks for your interest in contributing to CommitPulse! 🙏

Unfortunately, this PR has been automatically closed because you are not assigned to the linked issue #6095 — feat: add README Insight compact card in Generator section.

To avoid this in the future, please follow these steps:

  1. Claim the issue — Comment /claim on #6095 if you are the issue author, or ask a maintainer to /assign you.
  2. Wait for confirmation — The bot will confirm your assignment with a ✅ reply.
  3. Then open your PR — Link the issue with Fixes #6095 in your description.

💡 You can be assigned to up to 5 open issues at a time. Check your current assignments before claiming a new one.

We look forward to your contribution once you're assigned! 🚀

@github-actions github-actions Bot closed this Jun 20, 2026
@github-actions github-actions Bot added the type:feature New features, additions, or enhancements label Jun 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:feature New features, additions, or enhancements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: add README Insight compact card in Generator section

1 participant