Repository navigation
Tighten changelog and PR body guidance - #160
Merged
Merged
Conversation
Changelog entries are capped at one or two sentences (300 rendered characters, issue links excluded), start with the verb their section names, lead with the user-visible effect, and never narrate mechanism. Released sections are immutable; a fix for a defect that never shipped folds into the feature's entry. PR bodies start agent-written text with an LLM disclosure line and keep a 50-character imperative title, a one-sentence Why, and two to five one-line What bullets of at most 12 words. Root causes, measurements, run IDs, CI results, validation lists, diffs, and file lists live in commits, tests, and issues, never in the PR body. Commit subjects are capped at 72 characters with why-first bodies. Style adopted from ambiguous-interactive/unity-helpers. The two existing Unreleased entries are shortened to the new style. The 300-character cap has no lint yet; that is recorded as #159.
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.
DISCLOSURE: LLM-GENERATED TEXT
Why: Changelog entries grew into multi-sentence narratives and PR bodies drifted away from why the change exists and what it does, so reviewers cannot skim them.
What:
Refs #159
Type of Change
Checklist
Note
Low Risk
Documentation and changelog copy only; no runtime, packaging, or CI behavior changes.
Overview
Tightens agent and contributor writing rules for changelogs, commits, and pull requests across
.llm/context.md,ship-changes, andbump-version-release.CHANGELOG entries are now capped at one or two sentences (300 rendered characters), verb-first with user-visible effect first, with released sections immutable and pre-release fixes folded into feature entries. PRs require an
DISCLOSURE: LLM-GENERATED TEXTline on agent-written bodies, a 50-character imperative title, a one-sentence Why, and two to five What bullets of at most 12 words each; commit subjects stay within 72 characters. The two existing Unreleased items inCHANGELOG.mdare shortened to demonstrate the new style.Reviewed by Cursor Bugbot for commit aaedd8a. Bugbot is set up for automated code reviews on this repo. Configure here.