summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorPhilipp Bartsch <phil@grmr.de>2019-04-02 21:08:30 +0200
committerPatrick Georgi <pgeorgi@google.com>2019-04-04 10:36:03 +0000
commit81cd0b0aab95e4fb584073abde82d15ade7ce2a5 (patch)
tree606b0d83a8f65b50d9d9810d9f3ad78635107d37 /Documentation
parent654d7b5e0bf2d654e3db2bd10ce5c0824eb67f52 (diff)
Documentation: Fix invisible text
Encapsulate angled brackets in backticks '<filepath>' to make text visible in html rendering. Change-Id: I1ab926956c909aa3cd2fd92068ccb7b800dd1d4a Signed-off-by: Philipp Bartsch <phil@grmr.de> Reviewed-on: https://review.coreboot.org/c/coreboot/+/32146 Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net> Reviewed-by: Patrick Georgi <pgeorgi@google.com> Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/lessons/lesson2.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/Documentation/lessons/lesson2.md b/Documentation/lessons/lesson2.md
index c9c9484478..d6f800c290 100644
--- a/Documentation/lessons/lesson2.md
+++ b/Documentation/lessons/lesson2.md
@@ -130,8 +130,9 @@ The first line of your commit message is your commit summary. This is a brief
one-line description of what you changed in the files using the template
below:
-<filepath>: Short description
+`<filepath>: Short description`
*ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors*
+
**Note:** It is good practice to use present tense in your descriptions
and do not punctuate your summary.
@@ -171,8 +172,9 @@ In the textbox labeled "Commit summary" provide a brief one-line
description of what you changed in the files according to the template
below:
-<filepath>: Short description
+`<filepath>: Short description`
*ex. cpu/amd/pi/00630F01: Fix checkpatch warnings and errors*
+
**Note:** It is good practice to use present tense in your descriptions
and do not punctuate your short description.