Document commit message rules
gitlint is now capable of enforcing links. Document that for users.
Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I0322800529535db7dd7b291c252086161c52f754
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e9dbce3..153f371 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -229,9 +229,20 @@
this typically comes in the form of the class, module, handler, or directory you
are modifying. e.g. "apphandler: refactor foo to new API"
-Loosely, we try to follow the 50/72 rule for commit messages - that is, the
-subject line should not exceed 50 characters and the body should not exceed 72
-characters. This is common practice in many projects which use Git.
+Commit messages should follow the 50/72 rule: the subject line should not exceed
+50 characters and the body should not exceed 72 characters. This is common
+practice in many projects which use Git.
+
+Exceptions to this are allowed in the form of links, which can be represented in
+the form of:
+
+'''
+This implements [1]
+
+....
+
+[1] https://openbmc.org/myverylongurl.
+'''
All commit messages must include a "Signed-off-by" line, which indicates that
you the contributor have agreed to the Developer Certificate of Origin