Format Markdown with AI
Turn a rough draft into a readable issue, pull request or project note. Give the reviewer a summary and keep commands, evidence and test steps easy to find.
Format Markdown with AI when an otherwise useful bug report is hard to follow. A reviewer needs to know which screen to open, what action to take and how the result differs from the expected behaviour. Hand markdown-formatting your rough notes and it can arrange those details in an issue template.
A pull request calls for a different structure. Its template opens with the reason for the change, lists what changed and gives testing its own section. The same conventions work on longer documents, where heading levels and descriptive links help someone go straight to the relevant passage.
What it does
- Give a pull request a short opening that a reviewer can scan.
- Separate expected and actual behaviour in an issue.
- Turn a sequence of instructions into a numbered procedure.
- Distinguish an inline filename from a multiline code example.
- Use link text that tells a new contributor where the link goes.
Install and use
- Open the skill in your agent and supply the draft. Formatting the text needs no additional service or account.
- Ask “Could you turn these notes into an issue another developer can reproduce?” Include the observations you want preserved.
- Read the result against your notes, check that test outcomes are accurate and place it in your chosen editor.
FAQ
Source
Made by Britt Crawford. Original skill: markdown-formatting, published on GitHub under the MIT licence.
View on GitHub