Skip to content

Changelog style #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sedawwk merged 2 commits into from
Aug 27, 2026
Merged

Changelog style #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6cfdb2
docs: require terse CHANGELOG entries with a PR number
heshaoqiong-tuya Aug 27, 2026
03dfad3
docs(changelog): condense Unreleased to the new convention
heshaoqiong-tuya Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,14 @@ ctest --test-dir build --output-on-failure --no-tests=error --timeout 180 # ne
`printf` is a porting bug even where it links on the host. The one deliberate gap: `pal_t` has
only a monotonic `time_ms`, so ATOP signing reads libc `time(NULL)` — a port needs a real-time
clock the C library can see, or every signed request carries a `t` the cloud rejects.
6. **CHANGELOG entries are terse, and carry a PR number.** One line per change —
`- <module> — <what changed>(#<PR>).` — with indented sub-bullets only for specifics a reader
acts on (a new symbol, a changed default, a migration step). `## [0.3.0]` is the reference for
length and shape; put the entry under the right `Added` / `Changed` / `Fixed` heading, since
release notes are generated from those. Motivation, rejected alternatives, verification detail
and anything else answering *why* belong in the commit body — that is where a reader who wants
them will look, and repeating them here produces release notes nobody finishes reading. The PR
number is what links the one line back to all of it, so an entry without one is incomplete.

## Invariants

Expand Down
Loading