Glassvision/JuliaFEM.jl
1
0
Fork 0
mirror of https://github.com/JuliaFEM/JuliaFEM.jl.git synced 2026-08-06 04:21:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(contributing): note scaled commit message bodies

Browse Source 
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:
Jukka Aho
2026-05-09 16:44:46 +03:00
parent 0182fc7566
commit d711cab0d3
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CONTRIBUTING.md
+4
View File
@@ -66,6 +66,10 @@ when rendering the website) rather than chasing false positives in the library.
`.github/prompts/commit.prompt.md`. With `.github/prompts/commit.prompt.md`. With
`git config core.hooksPath .githooks`, the pre-commit hook allows at `git config core.hooksPath .githooks`, the pre-commit hook allows at
most **two** staged files per commit. 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 ## Documentation pull requests