Rename "Results" to "Issues" in markdown reports (#37)

* Initial plan

* Rename Results to Issues in markdown reports

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

* Update documentation to use Issues terminology

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

* Rename AppendResultsSection to AppendIssuesSection

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

* Fix self-validation to check for Issues instead of Results

Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Malcolmnixon <1863707+Malcolmnixon@users.noreply.github.com>

Author: Copilot

README.md

@@ -153,8 +153,8 @@ The generated markdown report includes:
 
 1. **Report Header** - Custom heading or tool name with "Analysis" suffix
 2. **Tool Information** - Tool name and version extracted from SARIF file
-3. **Results Summary** - Count of issues found in the analysis
-4. **Results List** - Detailed list of results in compiler-style format with file, line, level, rule ID, and message
+3. **Issues Summary** - Count of issues found in the analysis
+4. **Issues List** - Detailed list of issues in compiler-style format with file, line, level, rule ID, and message
 
 Example report structure:
 
@@ -163,9 +163,9 @@ Example report structure:
 
 **Tool:** MockTool 1.0.0
 
-## Results
+## Issues
 
-Found 2 results
+Found 2 issues
 
 src/Program.cs(42): warning [TEST001] Test issue 1
 src/Helper.cs(15): error [TEST002] Test issue 2

docs/guide/guide.md

@@ -154,7 +154,7 @@ Fail the build if any issues are found:
 sarifmark --sarif analysis.sarif --report report.md --enforce
 ```
 
-The command will exit with a non-zero exit code if the SARIF file contains any results.
+The command will exit with a non-zero exit code if the SARIF file contains any issues.
 
 ### Run Self-Validation
 
@@ -213,8 +213,8 @@ sarifmark --sarif other-tool.sarif --report other-report.md --heading "Other Too
 The generated markdown reports include:
 
 - **Tool Information**: Name and version of the analysis tool
-- **Summary**: Count of results found
-- **Results Details**: Detailed information about each finding, including:
+- **Summary**: Count of issues found
+- **Issues Details**: Detailed information about each finding, including:
   - File location and line number
   - Severity level
   - Rule ID

src/DemaConsulting.SarifMark/SarifResults.cs

@@ -354,7 +354,7 @@ public string ToMarkdown(int depth, string? heading = null)
         var sb = new StringBuilder();
 
         AppendHeader(sb, mainHeading, heading);
-        AppendResultsSection(sb, subHeading);
+        AppendIssuesSection(sb, subHeading);
 
         return sb.ToString();
     }
@@ -378,14 +378,14 @@ private void AppendHeader(StringBuilder sb, string heading, string? customHeadin
     }
 
     /// <summary>
-    ///     Appends the results section with count and details.
+    ///     Appends the issues section with count and details.
     /// </summary>
-    private void AppendResultsSection(StringBuilder sb, string subHeading)
+    private void AppendIssuesSection(StringBuilder sb, string subHeading)
     {
-        sb.AppendLine($"{subHeading} Results");
+        sb.AppendLine($"{subHeading} Issues");
         sb.AppendLine();
 
-        sb.AppendLine(FormatFoundText(Results.Count, "result"));
+        sb.AppendLine(FormatFoundText(Results.Count, "issue"));
         sb.AppendLine();
 
         if (Results.Count > 0)
@@ -405,7 +405,7 @@ private void AppendResultsSection(StringBuilder sb, string subHeading)
     /// </summary>
     /// <param name="count">The count value.</param>
     /// <param name="singularNoun">The singular form of the noun.</param>
-    /// <returns>Formatted text like "Found no results", "Found 1 result", or "Found 5 results".</returns>
+    /// <returns>Formatted text like "Found no issues", "Found 1 issue", or "Found 5 issues".</returns>
     private static string FormatFoundText(int count, string singularNoun)
     {
         return count switch

src/DemaConsulting.SarifMark/Validation.cs

@@ -137,7 +137,7 @@ private static void RunMarkdownReportGenerationTest(Context context, DemaConsult
                 }
 
                 if (reportContent.Contains("MockTool Analysis") &&
-                    reportContent.Contains("Found 2 results"))
+                    reportContent.Contains("Found 2 issues"))
                 {
                     return null;
                 }

test/DemaConsulting.SarifMark.Tests/SarifResultsTests.cs

@@ -681,8 +681,8 @@ public void SarifResults_ToMarkdown_Depth1_ProducesCorrectOutput()
         Assert.IsNotNull(markdown);
         Assert.Contains("# TestTool Analysis", markdown);
         Assert.Contains("**Tool:** TestTool 1.0.0", markdown);
-        Assert.Contains("## Results", markdown);
-        Assert.Contains("Found 2 results", markdown);
+        Assert.Contains("## Issues", markdown);
+        Assert.Contains("Found 2 issues", markdown);
         Assert.Contains("src/MyClass.cs(42): warning [CA1001] Types that own disposable fields should be disposable", markdown);
         Assert.Contains("src/Program.cs(15): error [CA2000] Dispose objects before losing scope", markdown);
     }
@@ -702,7 +702,7 @@ public void SarifResults_ToMarkdown_Depth3_UsesCorrectHeadingLevels()
         // Assert
         Assert.Contains("### TestTool Analysis", markdown);
         Assert.Contains("**Tool:** TestTool 1.0.0", markdown);
-        Assert.Contains("#### Results", markdown);
+        Assert.Contains("#### Issues", markdown);
     }
 
     /// <summary>
@@ -718,7 +718,7 @@ public void SarifResults_ToMarkdown_NoResults_ShowsFoundNoResults()
         var markdown = results.ToMarkdown(1);
 
         // Assert
-        Assert.Contains("Found no results", markdown);
+        Assert.Contains("Found no issues", markdown);
     }
 
     /// <summary>
@@ -739,8 +739,8 @@ public void SarifResults_ToMarkdown_OneResult_UsesSingularForm()
         var markdown = results.ToMarkdown(1);
 
         // Assert
-        Assert.Contains("Found 1 result", markdown);
-        Assert.DoesNotContain("Found 1 results", markdown);
+        Assert.Contains("Found 1 issue", markdown);
+        Assert.DoesNotContain("Found 1 issues", markdown);
     }
 
     /// <summary>
@@ -786,7 +786,7 @@ public void SarifResults_ToMarkdown_Depth6_ProducesCorrectOutput()
         // Assert
         Assert.Contains("###### TestTool Analysis", markdown);
         Assert.Contains("**Tool:** TestTool 1.0.0", markdown);
-        Assert.Contains("###### Results", markdown); // Capped at 6
+        Assert.Contains("###### Issues", markdown); // Capped at 6
     }
 
     /// <summary>