docs: clarify v3 changelog is auto-generated in CONTRIBUTING.md#5624
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughA single line in ChangesChangelog Contribution Guidance Fix
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
CONTRIBUTING.md told v3 contributors to update v3/UNRELEASED_CHANGELOG.md, but the auto-changelog-v3.yml workflow already generates a v3 entry from the PR on merge (it only skips when the PR added one itself). The PR template correctly states v3 entries are automatic, so align CONTRIBUTING.md with that behaviour and note the manual override. Fixes wailsapp#5623 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
420e336 to
556c5d7
Compare
|
Thank you! 🙏 |
Description
CONTRIBUTING.mdtells v3 contributors to updatev3/UNRELEASED_CHANGELOG.md, but that contradicts the PR template, which says v3 changelog entries are added automatically.The template is the accurate one.
.github/workflows/auto-changelog-v3.ymlruns on PR merge and auto-generates a v3 changelog entry; it only skips the auto-fill when the PR already touchedv3/UNRELEASED_CHANGELOG.md. So a v3 entry is never required from the contributor — at most it's an optional way to control the wording.This updates the
CONTRIBUTING.mdv3 line to match that behaviour: entries are added automatically, with a manual entry as an optional override. No change to the PR template, which was already correct.Fixes #5623
Type of change
How Has This Been Tested?
Documentation-only change to
CONTRIBUTING.md. No code paths are affected, so there is nothing to run on a specific OS. Verified the new wording matches the actualauto-changelog-v3.ymlbehaviour and the existing PR template statement.Test Configuration
N/A — documentation-only change,
wails doctornot applicable.Checklist:
website/src/pages/changelog.mdxwith details of this PR (v3 changelog entries are added automatically)Summary by CodeRabbit