Skip to content

fix: markdown formatting in code review examples#671

Open
timdeschryver wants to merge 2 commits intogithub:mainfrom
timdeschryver:patch-1
Open

fix: markdown formatting in code review examples#671
timdeschryver wants to merge 2 commits intogithub:mainfrom
timdeschryver:patch-1

Conversation

@timdeschryver
Copy link

Updated markdown code blocks for example comments in the code review instructions.

Pull Request Checklist

  • I have read and followed the CONTRIBUTING.md guidelines.
  • My contribution adds a new instruction, prompt, agent, or skill file in the correct directory.
  • The file follows the required naming convention.
  • The content is clearly structured and follows the example format.
  • I have tested my instructions, prompt, agent, or skill with GitHub Copilot.
  • I have run npm start and verified that README.md is up to date.

Description

The markdown code blocks are currently not well formatted in the "Example Comments" section. This also impacts the "Review Checklist" section.

This PR uses 4 ticks to create the example markdown templates, so that the code blocks (and text) of the markdown content blocks are correctly formatted.

Before:
image

After:
image


Type of Contribution

  • New instruction file.
  • New prompt file.
  • New agent file.
  • New collection file.
  • New skill file.
  • Update to existing instruction, prompt, agent, collection or skill.
  • Other (please specify):

Additional Notes


By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.

Updated markdown code blocks for example comments in the code review instructions.
Copilot AI review requested due to automatic review settings February 6, 2026 10:18
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes markdown formatting in the code review instructions file by correctly nesting code blocks within example comments. The issue was that triple backticks were used for both outer and inner code blocks, preventing proper rendering of the nested code examples.

Changes:

  • Updated example comment blocks to use quadruple backticks (````) instead of triple backticks (```) to properly nest code blocks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant