Skip to content

Commit 3f84e95

Browse files
committed
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
1 parent 1adafbb commit 3f84e95

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

CONTRIBUTING.md

+14-3
Original file line numberDiff line numberDiff line change
@@ -229,9 +229,20 @@ Try to include the component you are changing at the front of your subject line;
229229
this typically comes in the form of the class, module, handler, or directory you
230230
are modifying. e.g. "apphandler: refactor foo to new API"
231231

232-
Loosely, we try to follow the 50/72 rule for commit messages - that is, the
233-
subject line should not exceed 50 characters and the body should not exceed 72
234-
characters. This is common practice in many projects which use Git.
232+
Commit messages should follow the 50/72 rule: the subject line should not exceed
233+
50 characters and the body should not exceed 72 characters. This is common
234+
practice in many projects which use Git.
235+
236+
Exceptions to this are allowed in the form of links, which can be represented in
237+
the form of:
238+
239+
'''
240+
This implements [1]
241+
242+
....
243+
244+
[1] https://openbmc.org/myverylongurl.
245+
'''
235246

236247
All commit messages must include a "Signed-off-by" line, which indicates that
237248
you the contributor have agreed to the Developer Certificate of Origin

0 commit comments

Comments
 (0)