skills.rest
microsoft
microsoftOFFICIAL
Explore all skills by this author →
Website𝕏@OpenAtMicrosoftGitHub

pr-review-comments

Submit inline review comments on GitHub Pull Requests via CLI and API.

561|190|Updated May 16, 2024
Search Tags:#code review#pull request#api#github#cli#comments
One-click install
npx skills add https://github.com/microsoft/semantic-link-labs --skill pr-review-comments-microsoft
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: pr-review-comments
Source: https://github.com/microsoft/semantic-link-labs/tree/main/.claude/skills/pr-review-comments
Command: npx skills add https://github.com/microsoft/semantic-link-labs --skill pr-review-comments-microsoft

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill streamlines the process of providing specific, line-by-line feedback on code changes within GitHub Pull Requests, making code reviews more efficient and actionable.

Core Features & Use Cases

  • Inline Commenting: Post review comments directly on specific lines of code in a PR diff.
  • API Integration: Leverages the GitHub CLI and API for programmatic comment submission.
  • Use Case: When reviewing a colleague's pull request, you can use this skill to point out a potential bug on line 40 of a specific file and suggest a minor improvement on line 21 of another file, all with a single command.

Quick Start

Use the pr-review-comments skill to post an inline comment on line 40 of the file src/path/to/file.py in the current pull request with the message "This line needs attention.".

Frequently Asked Questions about pr-review-comments

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

FAQPage Schema
How do I post inline code review comments on a GitHub pull request?▼

To post inline code review comments on a GitHub pull request, you can automate the submission process by specifying file paths, line numbers, and comment bodies. This leverages the GitHub CLI and API for targeted feedback directly on specific lines of code.

Can I approve a pull request or request changes using the GitHub CLI API?▼

Yes, you can approve a pull request or request changes using the GitHub CLI API. The submission process supports structured review events like COMMENT, APPROVE, and REQUEST_CHANGES alongside your inline code feedback.

How do I automate targeted code feedback on specific file lines in a PR diff?▼

You automate targeted code feedback on specific file lines in a PR diff by specifying the exact file path and line number in your API request. This allows you to programmatically point out bugs or suggest improvements on exact lines.

Does the GitHub CLI support Markdown formatting for pull request review comments?▼

Yes, the GitHub CLI supports Markdown formatting for pull request review comments. You can format the comment body content using Markdown when submitting inline feedback through the API.

What is the best way to point out a potential bug on a specific line of code in a PR?▼

The best way to point out a potential bug on a specific line of code in a PR is to submit an inline review comment through the GitHub API. You provide the file path, target line number, and formatted message to deliver precise feedback.

Do I need to use the GitHub API to submit multiple inline comments on a pull request?▼

Yes, you need to use the GitHub API via the GitHub CLI to submit multiple inline comments on a pull request. This programmatic approach allows you to target multiple files and line numbers with a single command.

Related Skills

Explore More Software Engineering Skills→
granietgraniet
247

github-auth

Automates GitHub authentication setup for git, SSH, gh CLI, and API access.

Community
Intermediate
dimakisdimakis

land-pr

Shepherd GitHub pull requests through CI checks, reviews, and squash merges.

Community
Intermediate
JuanMS20JuanMS20

github-code-review

Generate structured code review feedback and inline comments for GitHub pull requests and local diffs.

Community
Intermediate
GamezarGamezar

git-attach-review-to-pr

Add line-specific review comments to GitHub pull requests via the GitHub CLI API.

Community
Intermediate