Skip to content

feat(generator): Enhance README customization with multiple layout templates - #8988

Merged
JhaSourav07 merged 5 commits into
JhaSourav07:mainfrom
Rakshak05:issue-#7814
Aug 18, 2026
Merged

feat(generator): Enhance README customization with multiple layout templates#8988
JhaSourav07 merged 5 commits into
JhaSourav07:mainfrom
Rakshak05:issue-#7814

Conversation

@Rakshak05

Copy link
Copy Markdown
Contributor

Description

Fixes #7814

Added support for structural layout templates (Classic, Minimalist, Data Heavy, Storyteller) in readmeGenerator.ts and the README Editor UI, enabling users to customize the ordering of their profile sections.

Summary of Changes:

  • Types & State: Defined LayoutTemplate ('classic' | 'minimalist' | 'data-heavy' | 'storyteller') in types.ts and added layoutTemplate to GeneratorState.
  • Generator Core: Modularized section builders in readmeGenerator.ts and arranged sections dynamically according to the chosen template.
  • UI Editor: Created the LayoutTemplateSection component in the editor sidebar with visual template badges and section order previews.
  • Presets: Configured default PROFILE_PRESETS with matching layout templates.
  • Test Coverage: Added dedicated unit tests in readmeGenerator.layout-templates.test.ts verifying section reordering across all templates.

Pillar

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

Visual Preview

(Optional: Attach a screenshot or GIF of the new Layout Template selector card from the generator UI)

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(themes): ..., fix(calculate): ...).
  • I have updated README.md if I added a new theme or URL parameter.
  • I have starred 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.

Copilot AI lite review requested due to automatic review settings August 10, 2026 11:46
@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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

A member of the Team first needs to authorize it.

@retenta-bot

retenta-bot Bot commented Aug 10, 2026

Copy link
Copy Markdown

This pull request introduces multiple layout templates for the README generator, enhancing user customization options. It aligns with previous decisions to improve user experience, such as the addition of a dark/light preview background toggle. This feature will allow users to visualize their README in different contexts, similar to how the background toggle enhances the contribution graph embed preview. Great work on this! Looking forward to your contributions.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@retenta-bot retenta-bot Bot changed the title feat(generator): Add support for multiple layout templates-#7814 feat(generator): Enhance README customization with multiple layout templates Aug 10, 2026
@github-actions github-actions Bot added the status:blocked This PR is blocked due to a failing CI check. label Aug 10, 2026
@github-actions github-actions Bot removed the status:blocked This PR is blocked due to a failing CI check. label Aug 10, 2026
@github-actions

github-actions Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Size Report (Gzipped Sizes)

Asset PR Size Base Size Difference Status
static/chunks/app/generator/page-[hash].js 37.76 KB 36.59 KB +1.17 KB (+3.21%) 🔴 Regression
static/css/[hash].css 43.75 KB 43.67 KB +0.08 KB (+0.19%) 🔴 Regression

📊 Summary of Totals

Category PR Size Base Size Difference
Total JS 5009.05 KB 5005.04 KB +4.00 KB (+0.08%)
Total CSS 355.62 KB 354.80 KB +0.82 KB (+0.23%)

@github-actions github-actions Bot added the type:feature New features, additions, or enhancements label Aug 12, 2026
@Aamod007 Aamod007 added mentor:Aamod007 level:intermediate Moderate complexity tasks quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. labels Aug 13, 2026

@Aamod007 Aamod007 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a great feature! Breaking down the monolithic README generation into specific section-builder functions in
eadme-generator.ts\ makes the code much cleaner and easier to maintain. The new \minimalist, \data-heavy, and \storyteller\ layout templates offer fantastic customization options for users, and dynamically ordering the sections based on the chosen template is implemented very elegantly.

Labels applied:

  • type:feature: Adds multiple README layout templates and graph placement options.
  • level:intermediate: Good architectural refactoring of string generation logic into manageable, composable blocks.
  • quality:clean: The code is well-organized and much more readable now.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ Hey @Rakshak05, this pull request has been inactive for 3 days. It will be automatically closed in 2 days if no further activity occurs.

If you are still working on this, please push your latest changes or leave a comment to keep it active.

@Rakshak05

Copy link
Copy Markdown
Contributor Author

⚠️ Hey @Rakshak05, this pull request has been inactive for 3 days. It will be automatically closed in 2 days if no further activity occurs.

If you are still working on this, please push your latest changes or leave a comment to keep it active.

waiting for maintainer.
:')

@JhaSourav07 JhaSourav07 added the gssoc:approved PR has been reviewed and accepted for valid contribution points label Aug 18, 2026
@JhaSourav07
JhaSourav07 merged commit 4aef414 into JhaSourav07:main Aug 18, 2026
6 of 7 checks passed
@github-actions github-actions Bot added this to the GSSoC 2026 milestone Aug 18, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🎉 Congratulations @Rakshak05! Your PR has been successfully merged. 🚀

Thank you for contributing to CommitPulse. Your work helps us build a better tool for the community.

⚠️ Important for GSSoC Contributors:
You are strictly advised to join our Discord Server as it is mandatory for all GSSoC participants. All important announcements, point claims, and community discussions happen there.

Keep building! 💻✨

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

Labels

gssoc:approved PR has been reviewed and accepted for valid contribution points gssoc:needs-rebase level:intermediate Moderate complexity tasks mentor:Aamod007 quality:clean PR follows clean coding practices, proper formatting, documentation, and maintainability standards. type:feature New features, additions, or enhancements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Add Support for Multiple Layout Templates

4 participants