summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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.