docs(contributing): link issues with Refs, never Closes - #17
Merged
Conversation
CONTRIBUTING.md instructed contributors to write `Closes #123` in a commit footer, directly contradicting the issue workflow, which bans auto-close keywords. This was not a style preference. GitHub auto-closes an issue when a commit carrying `Closes`/`Fixes`/`Resolves` lands on the default branch, so the issue would close at merge time - before anything ran its acceptance criteria. An autonomous session following CONTRIBUTING.md would have silently defeated the verification gate on its first commit. Three changes: - The guideline now says `Refs koniz-dev/flutter-starter#123` and states why the auto-close keywords are banned, so nobody "helpfully" restores them. - The PR checklist item said only "Related issues are referenced (if any)", which was consistent with either convention; it now names Refs explicitly. - The Pull Requests section links docs/issue-workflow.md, so the rule is reachable from the contribution entry point rather than only from a doc a contributor may never open. Refs #10
This was referenced Aug 25, 2026
Closed
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
1 participant
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.
CONTRIBUTING.mdtold contributors to writeCloses #123in a commit footer -directly contradicting invariant 3 of the issue workflow, which bans auto-close
keywords.
Not a style preference. GitHub auto-closes an issue when a commit carrying
Closes/Fixes/Resolveslands on the default branch, so the issue closes atmerge time, before anything has run its
## Acceptance criteria. Thatremoves the verification gate the whole workflow exists to enforce. An autonomous
session following
CONTRIBUTING.mdwould have defeated it on its first commit.Changes
Refs koniz-dev/flutter-starter#123and states whythe auto-close keywords are banned - so the next person does not restore them
as a convenience.
compatible with either convention. It now names
Refsexplicitly.docs/issue-workflow.md, making the rulereachable from the contribution entry point rather than only from a document a
contributor might never open.
Note on checks
This PR touches only
CONTRIBUTING.md.ci.ymlhaspaths-ignorefor**/*.md, so it will report no checks at all - expected, not a failure.Refs #10