Add guidelines for commit messages

[linux-libre-firmware.git] / CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
index 18987c3b14968d1259c7b555c968af6261dfa97c..29e647398ab2e978d2b6af061f89dc82b0bdf97f 100644 (file)
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -28,6 +28,24 @@ message to the GNU Linux-libre mailing list:
 -   Your patch must also update the root level Makefile to build the
     firmware, as appropriate.
 
+Git Commit Messages
+-------------------
+
+-   Limit the subject to 50 characters.
+
+-   Use proper capitalization and imperative mood in the subject.
+
+-   Don't put a period at the end of the subject.
+
+-   Small changes, like fixing a typo, can get by with only a subject.
+    Larger changes should include a body too.
+
+-   Use a blank line to separate the subject and body.
+
+-   Use the body to explain the what and why of the change.
+
+-   Wrap the body at 70 characters.
+
 Development & Release Process
 -----------------------------