mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-08-06 04:21:33 +00:00
docs(contributing): note scaled commit message bodies
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`.
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user