]> source.dussan.org Git - sonarqube.git/commitdiff
SONAR-15343 Fix formatting on Adding Coding Rules page
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>
Wed, 1 Sep 2021 17:06:03 +0000 (12:06 -0500)
committersonartech <sonartech@sonarsource.com>
Wed, 1 Sep 2021 20:07:45 +0000 (20:07 +0000)
server/sonar-docs/src/pages/extend/adding-coding-rules.md

index 5b2f260be0b6f90371e00891ef2a6656889fcbbc..fbb5b49dcb0b72bfc8eff13d9b64f820124c2f08 100644 (file)
@@ -250,8 +250,8 @@ When an issue could be made clearer by highlighting multiple code segments, such
 
 
 ### Guidelines for Bug, Vulnerability, and Code Smell rules
-#### Titles
 
+#### Titles
 * The title of the rule should match the pattern "X should [ not ] Y" for most rules. Note that the "should [ not ]" pattern is too strong for Finding rules, which are about observations on the code. Finding titles should be neutral, such as "Track x".
 * All other things being equal, the positive form is preferred. E.G.
    * "X should Y" is preferred to 
@@ -299,7 +299,7 @@ Deprecated (optional): listing replacement rules with links
 
 Code samples for COBOL should be in upper case. 
 
-When displayed in SonarQube, any code or keywords in the description should be enclosed in <code> tags. For descriptions written in JIRA, this means using double curly braces (`{{` and `}}`) to enclose such text. They will be translated in the final output.
+When displayed in SonarQube, any code or keywords in the description should be enclosed in `<code>` tags. For descriptions written in JIRA, this means using double curly braces (`{{` and `}}`) to enclose such text. They will be translated in the final output.
 
 #### Messages
 Issue messages should contain the remediation message for bug and quality rules. For potential-bug rules, it should make it explicit that a manual review is required. It should be in the imperative mood ("Do x"), and therefore start with a verb.