docs: adopt the Punktfunk house style #438

Merged
enricobuehler merged 1 commits from worktree-house-style into main 2026-08-28 21:58:19 +00:00
1 Commits
Author SHA1 Message Date
enricobuehler ad6b5184dc docs: adopt the Punktfunk house style
ci / web (pull_request) Successful in 1m25s
ci / bun-nix (pull_request) Successful in 1m0s
ci / rust-arm64 (pull_request) Successful in 2m9s
ci / docs-drift (pull_request) Successful in 43s
ci / docs-site (pull_request) Successful in 1m44s
ci / rust (pull_request) Successful in 24m7s
Three writing surfaces were being asked to hold design reviews. Commit
subjects on main averaged 101 characters, CHANGELOG.md ran to 6,090
lines for eight versions, and module rustdoc carried milestone codes and
soak durations that git blame already keeps honest.

The rules now live in docs/writing.md: Conventional Commits with a
72-character cap, Keep a Changelog categories for new sections, and
comments that state an invariant rather than recap a diff. CONTRIBUTING,
AGENTS.md and the Gitea PR template point at it, and the CHANGELOG
header says which form new sections take.

Nothing existing is rewritten. The changelog archive, the release notes
and every current rustdoc header stay as they are; the style applies to
what gets written next.

Source: github.com/luxus/punktfunk-house-style
2026-08-28 23:48:25 +02:00