reactom-review

Validates code and documentation against Reatom v1001 best practices.

1.4k|138|Updated May 4, 2019
One-click install
npx skills add https://github.com/reatom/reatom --skill reactom-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: reactom-review
Source: https://github.com/reatom/reatom/tree/main/skills/reatom-review
Command: npx skills add https://github.com/reatom/reatom --skill reactom-review

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the challenge of maintaining code quality and adherence to Reatom best practices during the review process, by providing guidelines and checks.

Core Features & Use Cases

  • Code Review Guidance: Offers specific criteria for reviewing code, including async reads, state modeling, and naming conventions.
  • Documentation Validation: Ensures documentation claims align with Reatom behavior and API usage.
  • Use Case: When reviewing a pull request, use this Skill to validate the codebase against Reatom v1001 practices and identify areas for improvement.

Quick Start

Analyze the pull request 'PR-123' for Reatom best practices using the reatom-review skill.

Frequently Asked Questions about reactom-review

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

FAQPage Schema
How do I review code for Reatom state management best practices?

You can review code for Reatom state management best practices by validating reactivity, error handling, async patterns, state modeling, and API usage consistency against the criteria outlined in the Skill's reference documentation.

What should I check during a Reatom pull request review?

During a Reatom pull request review, check async reads, state modeling, naming conventions, and documentation claims to ensure they align with Reatom behavior and API usage guidelines.

How does Reatom handle async patterns and error handling in state management?

Reatom handles async patterns and error handling by requiring adherence to specific v1001 best practices during code validation, ensuring reactivity and state modeling remain consistent across the application.

Do I need prior Reatom knowledge to validate documentation against its API?

Yes, you need prior Reatom knowledge to validate documentation, as the process requires understanding Reatom v1001 behavior and API usage to ensure documentation claims align correctly.

What are the limitations of automated Reatom code review?

Automated Reatom code review limitations include reliance on predefined v1001 criteria and REFERENCE.md guidelines, meaning it cannot detect issues outside these outlined best practices or novel architectural deviations.