Repository navigation
State the changelog fragment cap where a contributor will see it - #259
Merged
Merged
Conversation
CONTRIBUTING.md asked for one sentence, two at most, but not the number changie enforces, so a contributor first met the 280 character cap as a rejection from `changie new`. The guideline now carries the number and the reason behind it. The pull request template gains a Changelog section with two boxes: a fragment was added, or the change is not user-visible.
github-actions
Bot
added
the
documentation
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.
Summary
CONTRIBUTING.mdasked for one sentence, two at most, but never said 280 — so a contributor met the cap as a rejection fromchangie newrather than as guidance. The number and its reasoning now sit in the PR guidelines, and the pull request template asks whether a fragment was added.Type of Change
Changes
CONTRIBUTING.md— the changelog bullet now states the 280 character cap enforced by.changie.yaml, and why a longer fragment belongs on a documentation page instead.github/PULL_REQUEST_TEMPLATE.md— new Changelog section with two boxes: fragment added, or the change is not user-visibleChangelog
changie newfragment added — one sentence, two at most, 280 characters maxTesting
make allpassesMarkdown only, no code paths touched. The cap itself was verified against the installed changie v1.26.0: a 300 character body is rejected with
input length too long: length of 300 > 280, a short one passes.Related Issues
Relates to #258