Merge pull request #169 from rostilos/1.5.5-rc

feat: Enhance Markdown formatting in output schemas for improved readability and clarity

Author: rostilos

LICENSE

@@ -1,5 +1,4 @@
 Functional Source License, Version 1.1, MIT Future License
-
 Copyright 2025-2026 CodeCrow
 
 ## Terms and Conditions

frontend

@@ -59,8 +59,8 @@ def normalize_scope(cls, v) -> str:
         return "LINE"
 
     title: Optional[str] = Field(default=None, description="Short issue title, max 10 words (e.g., 'Missing null check in user lookup')")
-    reason: str = Field(description="Detailed explanation of the issue, evidence, and impact")
-    suggestedFixDescription: str = Field(description="Description of the suggested fix")
+    reason: str = Field(description="Detailed explanation of the issue, evidence, and impact. Use Markdown formatting (inline code, bold, bullet lists, short code blocks) for readability.")
+    suggestedFixDescription: str = Field(description="Description of the suggested fix. Use Markdown formatting (inline code, bold, bullet lists) for readability.")
     suggestedFixDiff: Optional[str] = Field(default=None, description="Optional unified diff format patch for the fix")
     isResolved: bool = Field(default=False, description="Whether this issue from previous analysis is resolved")
     # Resolution tracking fields

java-ecosystem/target/failsafe-reports/failsafe-summary.xml

@@ -125,9 +125,9 @@
           "line": "42",
           "codeSnippet": "REQUIRED: exact line of source code at the issue location (copied verbatim from diff/file). Issues WITHOUT codeSnippet are DISCARDED.",
           "title": "Short issue title, max 10 words",
-          "reason": "Detailed explanation of the issue",
+          "reason": "Detailed explanation of the issue in **Markdown** format. Use inline code (`backticks`), bold, bullet lists, and short code blocks where appropriate to improve readability.",
           "resolutionReason": "When isResolved=true: specific explanation of HOW/WHY the issue was fixed (must NOT repeat the issue description)",
-          "suggestedFixDescription": "Clear description of how to fix the issue",
+          "suggestedFixDescription": "Clear description of how to fix the issue in **Markdown** format. Use inline code (`backticks`), bold, and bullet lists where appropriate.",
           "suggestedFixDiff": "Unified diff showing exact code changes (MUST follow SUGGESTED_FIX_DIFF_FORMAT)",
           "isResolved": false
         }}

python-ecosystem/inference-orchestrator/src/model/output_schemas.py

@@ -68,10 +68,10 @@
       "line": 42,
       "codeSnippet": "exact verbatim line of code from primary_file where the issue is most evident",
       "affected_files": ["path1", "path2"],
-      "description": "Pattern or risk spanning multiple files",
+      "description": "Pattern or risk spanning multiple files, in **Markdown** format. Use inline code, bold, and bullet lists where appropriate.",
       "evidence": "Which files exhibit this pattern and how they interact",
       "business_impact": "What breaks if this is not fixed",
-      "suggestion": "How to fix across these files"
+      "suggestion": "How to fix across these files, in **Markdown** format. Use inline code, bold, and bullet lists where appropriate."
     }}
   ],
   "data_flow_concerns": [