coding-standards

Enforces baseline coding conventions for naming, immutability, readability, and code-quality review.

2|Updated Mar 29, 2015
One-click install
npx skills add https://github.com/ovisan/dotfiles --skill coding-standards-ovisan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: coding-standards
Source: https://github.com/ovisan/dotfiles/tree/main/.agents/skills/coding-standards
Command: npx skills add https://github.com/ovisan/dotfiles --skill coding-standards-ovisan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams and AI-assisted coding sessions often produce inconsistent code with unclear naming, direct mutations, missing error handling, and structural code smells. This Skill provides a shared baseline of coding conventions so reviews, refactors, and new modules follow the same quality rules across projects. ## Core Features & Use Cases - Naming and Readability Rules: Enforces descriptive variable names, verb-noun function naming, and self-documenting code over comments. - Immutability and Type Safety: Mandates spread-based updates, typed interfaces, and avoidance of any in TypeScript/JavaScript code. - Code Smell Detection: Flags long functions, deep nesting, and magic numbers with concrete before/after examples. - Use Case: When reviewing a pull request, activate this Skill to check naming, error handling, async patterns, and test structure against a consistent baseline before approving. ## Quick Start Review this TypeScript module against the coding standards and list every violation with a suggested fix.

Frequently Asked Questions about coding-standards

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

FAQPage Schema
How do I enforce consistent coding standards across a project?▼

Apply a shared baseline of conventions covering naming, immutability, error handling, and file organization, then check code against it during reviews. This Skill provides that baseline with concrete good and bad examples for TypeScript and React.

What are the best practices for immutability in TypeScript?▼

Always use the spread operator to create updated copies of objects and arrays instead of mutating them directly. For example, use `{ ...user, name: 'New Name' }` rather than assigning `user.name` in place.

When should I use this skill instead of framework-specific guidelines?▼

Use it for cross-project concerns like naming, readability, immutability, and code-smell review. For React composition, hooks, backend architecture, or API design details, defer to the narrower frontend or backend skills it references.

How do I detect common code smells during review?▼

Watch for functions longer than about 50 lines, nesting deeper than a few levels, and unexplained magic numbers. Fix them by splitting functions, using early returns, and replacing literals with named constants.

Does this skill cover API design and validation?▼

It includes baseline REST conventions, consistent response envelopes, and Zod-based input validation examples. Deeper endpoint architecture and service-layer design are delegated to dedicated backend or API design skills.