Coding Standards

What it does

This skill enforces consistent coding standards and best practices across projects, improving code readability and maintainability for collaborative development. It provides guidelines on variable naming, function naming, immutability patterns, error handling, and async/await usage. The goal is to ensure a high level of code quality through established conventions.

When to use it

• Starting a new project or module
• Reviewing existing code for quality and maintainability
• Refactoring code to adhere to coding standards
• Onboarding new contributors to the team's coding conventions
• Setting up linting, formatting, or type-checking rules

Key capabilities

• Readability Focus: Prioritizes clear variable and function names over excessive commenting.
• KISS (Keep It Simple, Stupid): Encourages simple solutions and avoids premature optimization.
• DRY (Don't Repeat Yourself): Promotes extracting common logic into reusable functions and components.
• YAGNI (You Aren't Gonna Need It): Advocates for building features only when required.
• TypeScript/JavaScript Standards: Provides specific examples of good and bad practices for variable and function naming, immutability patterns, error handling, and async/await usage.

Example prompts

• "Review this code snippet for adherence to coding standards."
• "Suggest improvements to make this function more readable."
• "Check if this code follows the immutability pattern."

Tips & gotchas

• This skill provides guidelines and examples; it doesn't automatically enforce them. It’s intended as a reference for developers.
• The provided standards are specifically tailored to TypeScript/JavaScript projects.