From 3d25b266955e539fea376dd92c5ea7c28e3429d0 Mon Sep 17 00:00:00 2001 From: Tobi Dele-Safa <45383164+TobiD-S@users.noreply.github.com> Date: Tue, 10 Sep 2019 09:56:06 +0100 Subject: [PATCH] Update cl-descriptions.md --- review/developer/cl-descriptions.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/review/developer/cl-descriptions.md b/review/developer/cl-descriptions.md index 702dbd2..af107e3 100644 --- a/review/developer/cl-descriptions.md +++ b/review/developer/cl-descriptions.md @@ -35,8 +35,8 @@ though. ## Body is Informative {#informative} -The rest of the description should be informative. It might include a brief -description of the problem that's being solved, and why this is the best +The rest of the description should be informative. It might include a **brief +description** of the problem that's being solved, and why this is the best approach. If there are any shortcomings to the approach, they should be mentioned. If relevant, include background information such as bug numbers, benchmark results, and links to design documents. @@ -45,7 +45,7 @@ Even small CLs deserve a little attention to detail. Put the CL in context. ## Bad CL Descriptions {#bad} -"Fix bug" is an inadequate CL description. What bug? What did you do to fix it? +**"Fix bug"** is an inadequate CL description. What bug? What did you do to fix it? Other similarly bad descriptions include: - "Fix build."