Skip to content

docs: clarify v3 changelog is auto-generated in CONTRIBUTING.md#5624

Merged
leaanthony merged 1 commit into
wailsapp:masterfrom
Grantmartin2002:bugfix/5623_pr-template-v3-changelog
Jun 17, 2026
Merged

docs: clarify v3 changelog is auto-generated in CONTRIBUTING.md#5624
leaanthony merged 1 commit into
wailsapp:masterfrom
Grantmartin2002:bugfix/5623_pr-template-v3-changelog

Conversation

@Grantmartin2002

@Grantmartin2002 Grantmartin2002 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Description

CONTRIBUTING.md tells v3 contributors to update v3/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.yml runs on PR merge and auto-generates a v3 changelog entry; it only skips the auto-fill when the PR already touched v3/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.md v3 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

  • This change requires a documentation update

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 actual auto-changelog-v3.yml behaviour and the existing PR template statement.

  • Windows
  • macOS
  • Linux

Test Configuration

N/A — documentation-only change, wails doctor not applicable.

Checklist:

  • (v2 only) I have updated website/src/pages/changelog.mdx with details of this PR (v3 changelog entries are added automatically)
  • My code follows the general coding style of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Updated v3 (alpha) contribution guidelines to clarify that changelog entries are generated automatically on merge, and how to control the wording for your changes.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c40eb44d-9937-4c03-a41d-b04ec77b69af

📥 Commits

Reviewing files that changed from the base of the PR and between 420e336 and 556c5d7.

📒 Files selected for processing (1)
  • CONTRIBUTING.md
✅ Files skipped from review due to trivial changes (1)
  • CONTRIBUTING.md

Walkthrough

A single line in CONTRIBUTING.md is updated to replace the instruction to manually update v3/UNRELEASED_CHANGELOG.md with a description that v3 changelog entries are added automatically on PR merge, and that contributors can optionally add an entry to v3/UNRELEASED_CHANGELOG.md to control the wording.

Changes

Changelog Contribution Guidance Fix

Layer / File(s) Summary
v3 changelog instruction update
CONTRIBUTING.md
Rewrites the v3 changelog line to describe PR-merge automation and direct contributors to v3/UNRELEASED_CHANGELOG.md only for optional custom wording.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • wailsapp/wails#5269: Also modifies CONTRIBUTING.md v3 contribution instructions related to changelog wording via v3/UNRELEASED_CHANGELOG.md.

Suggested labels

Documentation

Poem

🐇 A line once misled, now set right,
The changelog writes itself at night!
No manual toil, just merge and see,
v3 entries flowing free ~
Hop along, contributors — it's easy as can be! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: clarifying that v3 changelog is auto-generated in the CONTRIBUTING.md file.
Description check ✅ Passed The description provides a clear summary of the issue, explains the contradiction between CONTRIBUTING.md and the PR template, details the actual behavior from auto-changelog-v3.yml, and documents the fix with proper issue reference.
Linked Issues check ✅ Passed The PR directly addresses issue #5623 by updating CONTRIBUTING.md to clarify that v3 changelog entries are auto-generated with optional manual overrides, fully meeting the issue's stated objective.
Out of Scope Changes check ✅ Passed The PR only modifies CONTRIBUTING.md to clarify v3 changelog documentation, which is precisely the scope of issue #5623 with no unrelated changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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>
@Grantmartin2002 Grantmartin2002 force-pushed the bugfix/5623_pr-template-v3-changelog branch from 420e336 to 556c5d7 Compare June 17, 2026 19:23
@leaanthony leaanthony merged commit 502b9c1 into wailsapp:master Jun 17, 2026
4 checks passed
@leaanthony

Copy link
Copy Markdown
Member

Thank you! 🙏

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.

PR template says v3 changelog is automatic, contradicting CONTRIBUTING.md

2 participants