team-coding-standards

Reviews pull request diffs against team naming, JSDoc, and comment conventions.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/TECH-HY/SKILLS --skill team-coding-standards-tech-hy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: team-coding-standards
Source: https://github.com/TECH-HY/SKILLS/tree/main/skills/team-coding-standards
Command: npx skills add https://github.com/TECH-HY/SKILLS --skill team-coding-standards-tech-hy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Inconsistent naming, missing documentation, and unclear comments slow down code reviews and create long-term maintenance debt. This Skill gives an AI reviewer a fixed, explicit rulebook so every pull request is checked against the same coding standards. ## Core Features & Use Cases - Naming Convention Checks: Enforces camelCase variables, UPPER_SNAKE_CASE constants, PascalCase classes and interfaces, and underscore-prefixed private fields, with common error examples. - Documentation Enforcement: Requires JSDoc on all public APIs (description, @param, @returns) and why-comments on complex logic. - Prioritized Diff Review: Analyzes only added lines in a diff and ranks violations as High (missing JSDoc), Medium (naming), or Low (missing why-comments). - Use Case: Paste a pull request diff and ask the agent to review it; it flags a public function missing JSDoc as high priority and a misnamed constant like max_retries as medium priority. ## Quick Start Review this pull request diff against the team coding standards and list all naming, JSDoc, and comment violations by priority.

Frequently Asked Questions about team-coding-standards

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

FAQPage Schema
How do I automate code review for naming conventions?

Apply a fixed naming rulebook during pull request review: camelCase for variables and functions, UPPER_SNAKE_CASE for constants, PascalCase for classes and interfaces, and an underscore prefix for private fields. The reviewer flags violations like my_variable or max_retries with corrected forms.

How to check JSDoc coverage in a pull request?

Check only the added lines in the diff and verify every public function, method, class, or exported variable has a JSDoc block. Minimum coverage includes a description, an @param tag per parameter, and an @returns tag; missing JSDoc on public APIs is treated as a high-priority violation.

Which lines of a diff should a code review check?

Review only lines marked with +, meaning new or changed code. Deleted lines marked with - are excluded from review since removed code no longer affects the codebase.

When should code comments be required in a review?

Require a why-comment when logic is non-obvious, using the criterion that a comment is needed if the next developer would spend more than 30 seconds understanding the code. Comments should explain intent, not restate what the code does.

What are the limitations of rule-based code review?

Rule-based review only catches violations covered by the defined standards, such as naming, JSDoc, and comments. It does not detect logic bugs, security issues, or architectural problems, so it should complement rather than replace human review and testing.