docs: the one-sentence rule was written down but nothing enforced it - #153
Merged
Merged
Conversation
#152 stated the rule in RELEASE.md and added a pre-flight checklist line, but the only enforcement was a manual checkbox read once per release — and the rule was invisible where a contributor actually lands: CONTRIBUTING.md and the PR checklist both linked RELEASE.md without saying what the rule is. `.changie.yaml` now sets `body.maxLength: 400`, which `changie new` refuses to exceed (401 characters rejected, 398 accepted). It is a ceiling for the two-sentence case rather than a target, and it does not see a hand-written fragment — both stated in RELEASE.md beside the rule. CONTRIBUTING.md and the PR checklist state the rule and link the section directly. The unreleased #151 fragment ran 482 characters, over the new cap; it is shortened to 397 with nothing dropped. The #152 fragment covers the cap and the two added surfaces.
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
#152 wrote the one-sentence changelog rule into RELEASE.md, but the only thing enforcing it was a manual pre-flight checkbox read once per release.
changie newnow refuses a body over 400 characters, and the rule is stated where a contributor actually lands rather than only behind a link.Related Issue
Refs #152
Changes
.changie.yamlsetsbody.maxLength: 400.changie newrejects a longer body at authoring time, so a paragraph never reacheschanges/unreleased/.Files Changed
.changie.yamlbody.maxLength: 400RELEASE.mdchangie newparagraphCONTRIBUTING.md.github/pull_request_template.mdchanges/unreleased/Documentation-20260906-234500.yamlchanges/unreleased/Documentation-20260906-185423.yamlTest Plan
changie new -k Fixed -b <401 chars> -m Issue=1 -d→Error: input length too long: length of 401 > 400; the same call with 398 characters renders the fragment.changie batch v1.2.0 --dry-runrenders both unreleased fragments unchanged in shape.sed -n 's/^ - label: //p' .changie.yaml(the kinds extraction inrelease.yml:222) still yields all seven kinds — the newbody:block does not perturb it.CHANGELOG.md(78) is still one or two sentences; no changelog output changes in this PR.Checklist
changie new, see Test Plan)golangci-lint run) — no Go files touched; pre-commit hooks passed