module-review

Automate module-level code reviews into standardized Markdown reports with P0 to P3 severity categories.

Updated Aug 17, 2024
One-click install
npx skills add https://github.com/LinoWhy/.dotfiles --skill module-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: module-review
Source: https://github.com/LinoWhy/.dotfiles/tree/main/agents/.agents/local-skills/module-review
Command: npx skills add https://github.com/LinoWhy/.dotfiles --skill module-review

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Produces a standardized, comprehensive module-level code review report to save time and ensure consistency across teams.

Core Features & Use Cases

  • Fixed Markdown Template: Generates reviews using a fixed template to ensure uniform structure.
  • Multi-Domain Coverage: Evaluates architecture, concurrency, memory, kernel interfaces, and API surfaces.
  • Output & Workflow: Writes the final report to a Markdown file, defaulting to <module>_code_review.md if not specified.

Quick Start

Provide the module name and path to review, then run the review to generate a fixed-template Markdown report.

Frequently Asked Questions about module-review

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

FAQPage Schema
How do I generate a comprehensive module code review report automatically?

Generate a standardized module code review by providing the module name and path, which outputs a Markdown report categorizing issues by severity levels P0 to P3 across architecture and API surfaces.

What does an automated module code review cover for architecture and concurrency?

Automated module code review evaluates architecture, concurrency models, memory usage, kernel interfaces, and API surfaces to produce a comprehensive standardized report for software subsystems.

How do I standardize code review reports across multiple software modules?

Standardize code review reports by applying a fixed Markdown template that ensures uniform structure and consistent issue severity categorization across multiple software modules and teams.

Can I use automated code review for kernel interfaces and memory usage analysis?

Yes, automated module code review evaluates kernel interfaces and memory usage, applying the fixed Markdown template to categorize identified issues by severity levels P0 to P3.

What is the default output file format for a module level code review?

The default output file format for a module level code review is a Markdown file, automatically named <module>_code_review.md unless a specific filename is specified.

How are issues categorized by severity in a generated code review report?

Issues in a generated code review report are categorized by severity levels P0 to P3, providing standardized prioritization for architecture, concurrency, memory, and API surface problems.