Skip to content

docs: improve changelog prompt for brevity and readability#1028

Merged
Kitenite merged 1 commit into
mainfrom
kiet-ho/changelog-prompt-update
Jan 28, 2026
Merged

docs: improve changelog prompt for brevity and readability#1028
Kitenite merged 1 commit into
mainfrom
kiet-ho/changelog-prompt-update

Conversation

@Kitenite
Copy link
Copy Markdown
Collaborator

@Kitenite Kitenite commented Jan 28, 2026

Summary

  • Lead with 2-4 major features that get their own sections
  • Group smaller improvements under a single "Improvements" heading
  • Add bug fixes as a footnote section at the bottom
  • Add content hierarchy table for clear PR categorization

Changes to prompt structure

PR Type Treatment
New user-facing feature Own section with heading
Significant improvement Own section or grouped
Small enhancement One line under "Improvements"
Bug fix One-liner in footnote at bottom
Internal/refactor Skip entirely

Test plan

  • Run workflow manually and verify changelog format

Summary by CodeRabbit

Release Notes

No user-facing changes. This update contains internal improvements to development automation and documentation guidelines only.

✏️ Tip: You can customize this high-level summary in your review settings.

- Lead with 2-4 major features, group smaller improvements
- Add bug fixes as footnote section at bottom
- Add content hierarchy table for PR categorization
- Emphasize brief, scannable writing style
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 28, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request updates the weekly automation guidance document to restructure PR categorization into explicit categories (Major Features, Improvements, Bug Fixes), refines prioritization workflow, enhances writing style guidelines, and adds a content hierarchy section for consistent PR presentation.

Changes

Cohort / File(s) Summary
Documentation & Guidance Update
\\.github/prompts/weekly-automation.md
Restructured PR categorization guidance with explicit categories; consolidated PR prioritization workflow; updated file creation naming conventions and slug usage; overhauled snippet templates with new headings and PRBadge URLs; expanded writing style rules with value-focused content; added Content hierarchy section; adjusted formatting rules for header images and bug-fix footnotes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guidance refreshed, so clear and neat,
Categories sorted, a weekly treat,
Major features leap and shine so bright,
While bugs footnoted feel quite light,
Hierarchy guides us, all is right! ✨


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Kitenite Kitenite merged commit d1ca78b into main Jan 28, 2026
11 of 12 checks passed
@Kitenite Kitenite deleted the kiet-ho/changelog-prompt-update branch January 28, 2026 07:17
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jan 28, 2026

🚀 Preview Deployment

🔗 Preview Links

Service Status Link
Neon Database (Neon) View Branch
Fly.io Electric (Fly.io) View App
Vercel API (Vercel) Open Preview
Vercel Web (Vercel) Open Preview
Vercel Marketing (Vercel) Open Preview
Vercel Admin (Vercel) Open Preview
Vercel Docs (Vercel) Open Preview

Preview updates automatically with new commits

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant