From d711cab0d3b6b0e249cf695e09127b6c626965c4 Mon Sep 17 00:00:00 2001 From: Jukka Aho Date: Sat, 9 May 2026 16:44:46 +0300 Subject: [PATCH] docs(contributing): note scaled commit message bodies MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Explain next to the one-file workflow that message depth should follow patch size—grouped bullets on large or multi-concern commits. - Adds one bullet under coding rules pointing readers at `.github/prompts/commit.prompt.md`. --- docs/CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0cf6b13..e111a37 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -66,6 +66,10 @@ when rendering the website) rather than chasing false positives in the library. `.github/prompts/commit.prompt.md`. With `git config core.hooksPath .githooks`, the pre-commit hook allows at most **two** staged files per commit. +- Match **commit message depth** to the patch: a short summary suffices for + small edits; **large files, large diffs, or several concerns in one commit** + should add **grouped bullets** (major API or behavior, wiring, migrations, + caveats) so history stays readable without re-walking every hunk. ## Documentation pull requests