CONTRIBUTING.md: improve

cabinpkg · Jan 8, 2025 · 56bb4f1 · 56bb4f1
1 parent e2f49ff
commit 56bb4f1
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -119,11 +119,14 @@ mkdocs build --strict
 
 ## Commit Message
 
-We generally follow the
+Read
 [Git Contribution Guidelines](https://git-scm.com/docs/SubmittingPatches#describe-changes).
 
-- **First Line**: `component: description of the patch` in all lowercase.
-- **Body**: Explain your change in 2-3 paragraphs:
+In a nutshell:
+
+- **First Line**: `component: description of the patch` in all lowercase
+  unless it's in a cap in the code.
+- **Body**: In 2-3 paragraphs:
   1. the current problem you want to solve
   2. justification of your change
   3. if any, alternative solutions considered but discarded