feat: add README Insight compact card#6107
Merged
Merged
Conversation
Aamod-Dev
added
level:beginner
Aamod-Dev
approved these changes
Jun 20, 2026
Aamod-Dev
left a comment
Aamod-Dev
left a comment
Collaborator
There was a problem hiding this comment.
Review Summary
Labels applied:
- level:beginner — Simple UI component with straightforward conditional logic in ReadmeInsight.tsx:18-49. No new backend, API, or complex state management — purely presentational with one useMemo hook.
- quality:clean — Well-structured code follows project conventions (Tailwind classes, lucide-react icons, useMemo pattern). Includes a test file (ReadmeInsight.test.tsx) covering empty state, partial state, and filled state scenarios.
- type:feature — New README Insight card component in the Generator section (GeneratorClient.tsx:105).
- type:testing — Comprehensive test suite with 4 test cases covering all conditional branches.
Mentor: Aamod007
Assessment: Clean, focused PR. The component fits well into the existing Generator layout, borrows patterns from neighbor components like ReadmeInsightsPanel, and includes proper TypeScript typing and accessibility (�ria-label on the container). The useMemo optimization is appropriate given the checks run against derived state. The test coverage is thorough — 4 cases hitting every branch of the conditional chain.
Approved! 🚀
Contributor
📦 Next.js Bundle Size Report (Gzipped Sizes)
📊 Summary of Totals
|
JhaSourav07
added
the
gssoc:approved
Contributor
|
🎉 Congratulations @RosheshChaware! Your PR has been successfully merged. 🚀 Thank you for contributing to CommitPulse. Your work helps us build a better tool for the community.
Keep building! 💻✨ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
No existing components were modified.
Pillar
Visual Preview
Checklist before requesting a review:
CONTRIBUTING.mdfile.localhost:3000/api/streak?user=YOUR_USERNAME).npm run formatandnpm run lintlocally and resolved all errors (CI will fail otherwise).feat: add README Insight card).README.mdif required.