code-review

Analyze embedded C/C++ pull requests for memory and thread safety issues.

1|23|Updated Jan 24, 2025
One-click install
npx skills add https://github.com/rdkcentral/telemetry --skill code-review-rdkcentral
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-review
Source: https://github.com/rdkcentral/telemetry/tree/main/.github/skills/code-review
Command: npx skills add https://github.com/rdkcentral/telemetry --skill code-review-rdkcentral

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires github-api, c++, analysis-tools, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the code review process for embedded C/C++ code, providing comprehensive analysis and reporting, thereby speeding up the review cycle and enhancing code quality.

Core Features & Use Cases

  • Comprehensive Code Analysis: Performs deep analysis of pull requests, including memory safety, thread safety, API compatibility, and error handling.
  • Visual Diffs: Generates visual summaries of code changes using Mermaid diagrams.
  • Regression Risk Assessment: Assesses the potential impact of code changes on the system.
  • Automated Reporting: Generates a REVIEW.md file with a structured analysis and recommendations.

Quick Start

To analyze a pull request, use: @workspace /code-review <PR_URL_OR_NUMBER>

Frequently Asked Questions about code-review

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

FAQPage Schema
How do I automate code review for embedded C/C++ pull requests?

Automate embedded C/C++ code review by analyzing pull requests for memory leaks, thread safety, and API compatibility. The process generates a REVIEW.md file containing structured analysis, visual diffs, and recommendations to streamline your review cycle.

What specific issues are analyzed during an automated C/C++ pull request review?

Automated C/C++ pull request review analyzes memory safety, thread safety, API compatibility, and error handling. It also assesses regression risks to evaluate the potential impact of code changes on the embedded system.

Do I need GitHub API access to analyze pull requests for memory leaks?

Yes, GitHub API access is required to analyze pull requests for memory leaks and thread safety. The automated analysis tool fetches embedded C/C++ code changes directly through the GitHub API to generate its review report.

How do I generate visual diffs for C/C++ code changes in GitHub pull requests?

Generate visual diffs for C/C++ code changes by running the automated review process on your GitHub pull request. It produces Mermaid diagrams that visually summarize the modifications alongside the detailed REVIEW.md report.

What is the best way to assess regression risk in embedded C/C++ projects?

Assess regression risk in embedded C/C++ projects by automating pull request analysis. The review evaluates the potential system impact of code changes and documents the regression risk assessment inside the generated REVIEW.md file.

Are there limitations when using automated analysis tools for C/C++ thread safety checks?

Automated C/C++ thread safety checks are limited to analyzing the code changes within a specific pull request. The analysis relies on available dependencies and tools to detect issues, meaning system-wide context outside the PR may be excluded.