code-reviewer

Automate structured code-review checks for the tt-xla project.

74|32|Updated Sep 13, 2024

Search Tags:#testing #coding-standards #code-review #cpp #pjrt #tt-xla

Ready to run

npx skills add https://github.com/tenstorrent/tt-xla --skill code-reviewer-tenstorrent

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: code-reviewer
Source: https://github.com/tenstorrent/tt-xla/tree/main/.claude/skills/code-reviewer
Command: npx skills add https://github.com/tenstorrent/tt-xla --skill code-reviewer-tenstorrent

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Code reviews for the tt-xla project can be inconsistent and time-consuming; this skill provides a structured, automated approach to enforce standards and catch issues early.

Core Features & Use Cases

Enforces memory safety in C++ PJRT plugin code, PJRT API pattern conformance, and Python test standards.
Validates adherence to the project's coding standards and antipattern guidelines using the provided references.
Use Case: A maintainer runs the code-reviewer on a PR to surface antipatterns and ensure compliance with tt-xla conventions.

Quick Start

Run the code-reviewer during a PR to automatically surface issues and enforce tt-xla coding standards.

Frequently Asked Questions about code-reviewer

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

FAQPage Schema

How do I automate code reviews for tt-xla C++ PJRT plugin code?▼

To review tt-xla C++ code, run the code-reviewer during a pull request to automatically verify memory safety, check PJRT API pattern conformance, and validate adherence to project coding standards.

What does structured code review check in Python tests and TT-XLA conventions?▼

Structured code review checks Python testing standards and validates adherence to tt-xla coding conventions and antipattern guidelines to ensure consistency across the project codebase.

How do I enforce memory safety and PJRT API patterns in C++ pull requests?▼

You can enforce memory safety and PJRT API patterns by running automated structured code-review checks on C++ pull requests, which verify conformance against tt-xla reference materials.

Can I validate tt-xla coding standards and antipattern guidelines automatically?▼

Yes, you can validate tt-xla coding standards automatically by running the code-reviewer on a pull request to surface antipatterns and ensure compliance with project conventions.

Why use reference materials for code review checks in the tt-xla project?▼

Reference materials provide the baseline for tt-xla conventions and antipatterns, allowing automated code-review checks to consistently verify memory safety, PJRT API patterns, and testing standards.

Does automated code review work with both C++ PJRT plugin and Python test files?▼

Yes, automated code review works with both C++ PJRT plugin files and Python tests, applying structured checks to verify memory safety, API patterns, and testing standards across the tt-xla codebase.