Agent skill

vendix-development-rules

General development rules.

Stars 163
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/vendix-development-rules

Metadata

Additional technical details for this skill

scope
[
    "root"
]
auto invoke
General Development

SKILL.md

Vendix Development Rules

CRITICAL SKILL - ALWAYS ACTIVE - Estas reglas son MANDATORIAS para toda interacciΓ³n con el cΓ³digo base.

🚨 MANDATORY REQUIREMENTS

Rule 1: ALWAYS Use Task Tools

YOU MUST USE Task tools for:

  • Complex, multi-step operations
  • Codebase exploration and research
  • Architectural decisions and planning
  • Any task affecting multiple files

NEVER attempt complex operations without proper task management.

bash
# βœ… CORRECTO: Usar Task tool para explorar
Task tool β†’ Explore agent β†’ "Find all payment-related files"

# ❌ INCORRECTO: Usar Grep/Glob directamente para tareas complejas
Grep tool β†’ Search "payment" (para anΓ‘lisis complejo)

When to use each agent:

  • Explore agent: Fast codebase exploration, finding files by patterns
  • Plan agent: Design implementation strategies before coding
  • general-purpose agent: Complex multi-step tasks requiring multiple tools
  • Bash: Simple terminal operations only (git, npm, docker)

metadata: scope: [root] auto_invoke: "Complex Tasks"

Rule 2: Consistency Over Preferences

ALWAYS prioritize:

  1. Established patterns in the codebase
  2. Existing conventions over personal preferences
  3. Code consistency across the project

NEVER:

  • Suggest "better" ways that differ from established patterns
  • Introduce new conventions without justification
  • Change working patterns for marginal improvements

Principle: If it works in the codebase, follow that pattern.


Rule 3: Code Quality Standards

YOU MUST MAINTAIN:

  • Strong typing: Use TypeScript interfaces, NEVER any
  • Modularity: Keep code modular and reusable
  • Multi-tenancy: Always consider tenant isolation
  • Error handling: Implement proper error handling at all layers
  • Documentation: Add comments only when logic isn't self-evident

AVOID:

  • Over-engineering simple solutions
  • Premature abstractions
  • Adding features "just in case"
  • Changing code that already works

Rule 4: Technology Constraints

BACKEND:

  • NEVER suggest JavaScript - Always TypeScript
  • NEVER bypass Prisma - Always use generated clients
  • NEVER hardcode tenant IDs - Use RequestContext (multi-tenant is automatic)

FRONTEND:

  • NEVER use promises for HTTP - Always RxJS Observables
  • NEVER create isolated state - Use global state when appropriate
  • NEVER hardcode branding - Resolve from domain config
  • NEVER use alert() - Use ToastService

Note: Backend uses global JWT authentication via APP_GUARD. Use @Public() decorator for public routes. See vendix-backend-auth for authentication patterns.


Rule 5: Before Making Changes

YOU MUST:

  1. Read existing code before suggesting changes
  2. Understand the pattern before implementing
  3. Follow existing structures unless explicitly requested to change
  4. Test builds after any code change

NEVER:

  • Propose changes without reading the file first
  • Assume patterns without verification
  • Skip build verification

Rule 6: File Organization

BACKEND DOMAINS:

apps/backend/src/domains/{domain}/
β”œβ”€β”€ {domain}.module.ts
β”œβ”€β”€ {domain}.controller.ts
β”œβ”€β”€ {domain}.service.ts
β”œβ”€β”€ dto/
└── entities/

FRONTEND MODULES:

apps/frontend/src/app/private/modules/{module}/
β”œβ”€β”€ {module}.component.ts
β”œβ”€β”€ {module}.component.html
β”œβ”€β”€ {module}.component.scss
β”œβ”€β”€ components/
β”‚   └── index.ts
β”œβ”€β”€ services/
β”‚   └── {module}.service.ts
└── interfaces/
    └── {module}.interface.ts

ALL COMPONENTS:

  • MUST be in folders - Even if standalone, even if small
  • MUST have index.ts - For clean exports
  • MUST follow naming - kebab-case for folders, PascalCase for classes

Rule 7: Verification Workflow

BEFORE completing ANY task:

  1. βœ… Check Docker logs for ALL modified components
  2. βœ… Verify ZERO errors exist
  3. βœ… Use appropriate commands:
    • Backend: docker logs --tail 40 vendix_backend
    • Frontend: docker logs --tail 40 vendix_frontend
    • Database: docker logs --tail 40 vendix_postgres
  4. βœ… Re-check after fixes
  5. βœ… Only then mark task complete

NO EXCEPTIONS - A task is NEVER complete with build errors.


🎯 Quick Reference

Task Tool/Approach
Explore codebase Task β†’ Explore agent
Plan implementation Task β†’ Plan agent
Complex multi-step Task β†’ general-purpose agent
Simple commands Bash tool directly
Find file by name Glob tool
Search content Grep tool
Read file Read tool

πŸ“‹ Decision Tree

Start Task
    β”‚
    β”œβ”€β†’ Is it complex/multi-step?
    β”‚   └─→ YES: Use Task tool
    β”‚   └─→ NO: Can I do it with one tool?
    β”‚       └─→ YES: Use that tool
    β”‚       └─→ NO: Use Task tool
    β”‚
    β”œβ”€β†’ Does it involve code changes?
    β”‚   └─→ YES: Read file first
    β”‚   └─→ Follow existing patterns
    β”‚   └─→ Verify build after
    β”‚
    └─→ Is it a new feature/module?
        └─→ YES: Use Plan agent first
        └─→ Get user approval
        └─→ Then implement

πŸ”΄ CRITICAL REMINDERS

  1. NEVER skip Task tools for complex operations
  2. NEVER compromise naming conventions (see vendix-naming-conventions)
  3. NEVER skip build verification (see vendix-build-verification)
  4. ALWAYS read existing code before changing
  5. ALWAYS follow established patterns

Related Skills

  • vendix-naming-conventions - ABSOLUTE PRIORITY for naming
  • vendix-build-verification - MANDATORY build checks
  • vendix-backend-domain - Backend domain patterns
  • vendix-frontend-component - Frontend component patterns

Expand your agent's capabilities with these related and highly-rated skills.

Didn't find tool you were looking for?

Be as detailed as possible for better results