docs: require issue/PR references in changelog entries#632
Open
isaacschepp wants to merge 2 commits intomainfrom
Open
docs: require issue/PR references in changelog entries#632isaacschepp wants to merge 2 commits intomainfrom
isaacschepp wants to merge 2 commits intomainfrom
Conversation
Update CLAUDE.md and CONTRIBUTING.md to mandate that every changelog entry includes an issue or PR reference. Add missing references to the four [Unreleased] entries that lacked them: Non-Gregorian calendar support (#564), glx merge (#264), glx migrate (#360), and born/died property removal (#360). Fixes #389
Deploying genealogix with
|
| Latest commit: |
4ea0386
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fd9d2fbb.genealogix.pages.dev |
| Branch Preview URL: | https://docs-changelog-references-v2.genealogix.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor guidance and the Unreleased changelog entries to ensure user-facing changes are traceable to an issue or PR.
Changes:
- Add a “reference required” rule for changelog entries to
CLAUDE.mdandCONTRIBUTING.md. - Add missing PR references to four
[Unreleased]entries inCHANGELOG.md.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Updates PR checklist to require an issue/PR reference in each changelog entry. |
CLAUDE.md |
Adds the same changelog reference requirement to the internal contributor guide. |
CHANGELOG.md |
Appends PR references to four Unreleased entries (non-Gregorian dates, merge, migrate, born/died removal). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Accept all common reference formats (Fixes #N, Closes #N, bare #N, parenthesized) instead of implying only parenthesized forms are valid. Addresses Copilot review feedback.
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
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.
Summary
(#123),(Fixes #123), or(PR #456)Fixes #389 (Phase 1 + Phase 2)
Replaces #625 (which was contaminated with unrelated commits from
feat/research-block-schema)Test plan
make check-linkspasses (no broken links introduced)