skills.rest
milespossing
milespossingCOMMUNITY
Explore all skills by this author →
GitHub

ado-pr-markdown

Writes Azure DevOps pull request descriptions using supported Markdown syntax and linking conventions.

Updated Jul 4, 2025
Search Tags:#templates#code review#markdown#pull request#azure devops#work items#pr description
One-click install
npx skills add https://github.com/milespossing/nixdots --skill ado-pr-markdown-milespossing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ado-pr-markdown
Source: https://github.com/milespossing/nixdots/tree/main/modules/agents/_skills/ado-pr-markdown
Command: npx skills add https://github.com/milespossing/nixdots --skill ado-pr-markdown-milespossing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Azure DevOps PR descriptions support only a subset of GitHub-flavored Markdown, and features like mermaid, KaTeX math, and in-table line breaks silently fail. This Skill tells you exactly which Markdown features work in ADO PR descriptions and comments, how to link work items, PRs, and users, and how to structure a clean PR write-up. ## Core Features & Use Cases - Support matrix: A verified table of which Markdown features render in PR descriptions versus wiki-only features to avoid. - Linking syntax: Correct shorthand for work items (#123, AB#123), cross-PR references (!456), user mentions, commits, branches, and builds. - Ready-to-fill templates: Six PR templates by change kind (feature, bug fix, refactor, revert, chore, draft) plus reusable snippets like screenshot rows and collapsible logs. - Use Case: You are migrating a GitHub PR body to Azure DevOps and need to convert task lists, collapsible sections, and AB# work-item links into syntax that actually renders in ADO. ## Quick Start Ask the assistant to draft an Azure DevOps PR description for your current diff using the appropriate template and linked work items.

Frequently Asked Questions about ado-pr-markdown

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a pull request description in Azure DevOps?▼

Start with a Summary section, add context under Why, list changes as bullets, and close with a Linked work block referencing work items. Use H2 headings since the PR title acts as H1, and pick a template matching your change kind such as feature, fix, or revert.

How do I link a work item in an Azure DevOps PR description?▼

Use #123 or AB#123 to link a work item in the current project; both add it to the PR's Linked work items section. Keywords like Fixes AB#123 can auto-transition the item on PR completion if that option is enabled.

Does Azure DevOps PR markdown support mermaid diagrams?▼

No, mermaid code blocks render as plain code in PR descriptions and comments. Export the diagram to PNG or SVG and embed it as an image instead.

Why do my line breaks disappear in Azure DevOps PR descriptions?▼

ADO does not treat a single newline as a line break. End the previous line with two trailing spaces before the newline to force a soft line break, or use a blank line to start a new paragraph.

Can I use tables with line breaks in Azure DevOps PR comments?▼

Tables render in PRs, but in-cell line breaks using <br/> do not work in PR descriptions even though they work in wikis. Use narrower columns, escape literal pipes with \|, and avoid checklists or fenced code inside table cells.

Related Skills

Explore More Software Engineering Skills→
J03Fr0stJ03Fr0st

pr-description

Generate pull request descriptions from git logs and diffs for GitHub and Azure DevOps.

Community
Intermediate
novel-jpnovel-jp

learn-gw-review

Resolve GitHub pull request review feedback through merge and ProjSight completion.

Official
Intermediate
samymitysamymity
1

verification-loop

Run build, type checking, linting, tests, security scans, and diff review on repository changes.

Community
Advanced
sltc-devsltc-dev

link-diff

Fetch code diffs from GitHub and GitLab pull request and commit URLs.

Community
Basic