Skip to content

fix: markdown formatting in code review examples #671

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

Open
timdeschryver wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −6
Open

fix: markdown formatting in code review examples #671

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
187c9d2
fix: markdown formatting in code review examples
timdeschryver Feb 6, 2026
83fe668
fix markdown code blocks
timdeschryver Feb 6, 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
12 changes: 6 additions & 6 deletions instructions/code-review-generic.instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ Explanation of the impact or reason for the suggestion.
### Example Comments

#### Critical Issue
```markdown
````markdown
**🔴 CRITICAL - Security: SQL Injection Vulnerability**

The query on line 45 concatenates user input directly into the SQL string,
Expand All @@ -265,10 +265,10 @@ stmt.setString(1, email);
```

**Reference:** OWASP SQL Injection Prevention Cheat Sheet
```
````

#### Important Issue
```markdown
````markdown
**🟡 IMPORTANT - Testing: Missing test coverage for critical path**

The `processPayment()` function handles financial transactions but has no tests
Expand All @@ -290,10 +290,10 @@ test('should process full refund when order is cancelled', () => {
expect(result.status).toBe('refunded');
});
```
```
````

#### Suggestion
```markdown
````markdown
**🟢 SUGGESTION - Readability: Simplify nested conditionals**

The nested if statements on lines 30-40 make the logic hard to follow.
Expand All @@ -318,7 +318,7 @@ if (!user || !user.isActive || !user.hasPermission('write')) {
}
// do something
```
```
````

## Review Checklist

Expand Down
Loading