project-code-standards

Enforce unified coding standards for Vue/Nuxt projects.

724|133|Updated May 3, 2024
One-click install
npx skills add https://github.com/KiWi233333/JiwuChat --skill project-code-standards
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-code-standards
Source: https://github.com/KiWi233333/JiwuChat/tree/main/.cursor/skills/project-code-standards
Command: npx skills add https://github.com/KiWi233333/JiwuChat --skill project-code-standards

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Enforces consistent coding conventions across the project's Vue/Nuxt stack, ensuring readable, maintainable, and scalable codebase.

Core Features & Use Cases

  • Centralized coding and naming conventions for Vue components, composables, APIs, and commits to promote cohesion.
  • Comprehensive reference of guidelines covering coding style, Vue components, styling, icons, SCSS, routing, and architecture to accelerate onboarding and reviews.
  • Use Case: When contributors add new components, hooks, or styles, consult the doc to align with project standards and avoid style drift.

Quick Start

Consult the coding-standards docs before contributing or reviewing code.

Frequently Asked Questions about project-code-standards

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

FAQPage Schema
How do I enforce a unified coding standard across Vue and Nuxt projects?

To enforce a unified coding standard across Vue and Nuxt projects, apply centralized guidelines for file structure, naming conventions, and commits to ensure readable and maintainable code across all contributors.

What naming conventions should I use for Vue components and composables?

For Vue components and composables, use centralized naming conventions specified in the coding standards documentation to maintain cohesion, prevent style drift, and accelerate the code review process.

How do I standardize commit messages for my Nuxt codebase?

Standardize commit messages for your Nuxt codebase by following the specified commit conventions within the coding standards, ensuring consistent project documentation and readable git history.

What is the best way to prevent code style drift when multiple contributors write Vue code?

The best way to prevent code style drift is to consult comprehensive coding guidelines covering styling, icons, and architecture before contributing, ensuring all Vue code aligns with project standards.

Does this coding standard cover SCSS styling and routing architecture?

Yes, the coding standard covers SCSS styling and routing architecture, providing a comprehensive reference of guidelines that accelerates onboarding and guides code reviews.

When do I need to consult project code standards during development?

You need to consult project code standards when adding new components, hooks, or styles, ensuring your contributions align with the Vue/Nuxt stack requirements and avoid style drift.