Repository navigation
Ban plan shorthand, name forward references - #1
Merged
Merged
Conversation
Commit messages and comments inherit shorthand from the room they were written in: plan-step labels, bare first names, and process narration that points at nothing once the plan is out of reach. A reader of the tree meets "until step B" and "review found three problems" with no way to resolve either. Ban working-context shorthand as a leak class in upstream-hygiene, and require forward references to name the artifact the later patch introduces — the function, helper, or contract — while a prep patch still justifies itself on the problem that exists now. Ported from the forward-reference and audience rules in kernel-style changelog-style.md (https://github.com/rikvanriel/kernel-style); distilled rules recorded in docs/references/kernel-style-as-example.md.
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.
Commit messages and comments inherit shorthand from the room they were written in: plan-step labels, bare first names, and process narration that points at nothing once the plan is out of reach. A reader of the tree meets "until step B" and "review found three problems" with no way to resolve either.
Ban working-context shorthand as a leak class in upstream-hygiene, and require forward references to name the artifact the later patch introduces — the function, helper, or contract — while a prep patch still justifies itself on the problem that exists now.
Ported from the forward-reference and audience rules in kernel-style changelog-style.md (https://github.com/rikvanriel/kernel-style); distilled rules recorded in docs/references/kernel-style-as-example.md.