Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rostilos merged 3 commits into from
Mar 17, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
350cf27
feat: Enhance Markdown formatting in output schemas for improved read…
rostilos Mar 17, 2026
a25e50b
test review functionality
rostilos Mar 17, 2026
6023d3b
Remove test text part from license
rostilos Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Functional Source License, Version 1.1, MIT Future License

Copyright 2025-2026 CodeCrow

## Terms and Conditions
Expand Down
2 changes: 1 addition & 1 deletion frontend
Open in desktop
Submodule frontend updated 3 files
+3 −6 src/pages/Account/Project/AnalysisSourceView.tsx
+6 −3 src/pages/Account/Project/IssueDetails.tsx
+2 −3 src/pages/Account/Project/ProjectSettings.tsx
8 changes: 0 additions & 8 deletions java-ecosystem/target/failsafe-reports/failsafe-summary.xml
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions python-ecosystem/inference-orchestrator/src/model/output_schemas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions python-ecosystem/inference-orchestrator/src/utils/prompts/constants_stage_1.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}}
Expand Down
4 changes: 2 additions & 2 deletions python-ecosystem/inference-orchestrator/src/utils/prompts/constants_stage_2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""

Check notice on line 1 in python-ecosystem/inference-orchestrator/src/utils/prompts/constants_stage_2.py

View check run for this annotation

CodeCrow-Local / CodeCrow Analysis

Potential Formatting Inconsistency Between Stage 1 and Stage 2 Prompts 

Potential Formatting Inconsistency Between Stage 1 and Stage 2 Prompts
The PR aims to enhance **Markdown formatting** in output schemas. There is a risk that formatting updates applied to `constants_stage_2.py` (or its associated schema) may not be mirrored in `constants_stage_1.py`, leading to a disjointed user experience or inconsistent LLM parsing behavior across the inference pipeline stages.
Evidence: Dependency analysis shows `constants_stage_2.py` is linked to `constants_stage_1.py` wi...
Raw output 
Suggested fix:
Verify that any **Markdown enhancements** (such as bolding keys, list indentation, or code block usage) are applied consistently to both `constants_stage_1.py` and `constants_stage_2.py`. If a shared schema utility exists, consider centralizing the formatting logic there.
Prompt template for Stage 2: Cross-file & architectural analysis.
"""

Expand Down Expand Up @@ -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": [
Expand Down