coding-guidelines

Principios core para trabajar con LLMs en tareas de desarrollo.


Triggers

Frases que activan el skill
“buenas practicas”
“best practices”
“coding guidelines”
“code quality”
“clean code”
“principios de codigo”
“refactorizar con principios”

4 Principios

1. Pensa Antes de Codear

NO empezar a escribir codigo inmediatamente. Surfacea assumptions, pregunta sobre preferencias, presenta opciones con trade-offs, confirma alineamiento.

2. Simplicidad Primero

El codigo mas simple que resuelve el problema. KISS, DRY, YAGNI siempre. Sin abstracciones especulativas. 3 lineas similares > abstraccion prematura.

3. Cambios Quirurgicos

Editar lo minimo necesario. Matchear patterns existentes. No refactorizar codigo que no toca la feature. No agregar docstrings/comments donde no habia.

4. Objetivos Verificables

Criterios claros para saber cuando esta listo. Tests que validen el comportamiento. Checkear lint, types, build antes de terminar.


Ejemplo: Usuario pide agregar feature

MAL (sin consultar):

import winston from 'winston';
const logger = winston.createLogger({...});

BIEN (consultar primero):

Antes de agregar logging, necesito entender:
1. Que libreria prefieren?
2. A donde van los logs?
3. Hay un formato estandar en el proyecto?

Anti-patrones

Anti-Pattern Problema
Saltar a codear sin discutir Se asumen decisiones que el usuario no pidio
Agregar features “por las dudas” Codigo extra que mantener sin valor
Refactorizar de paso PR con cambios mezclados, dificil de revisar
Over-engineering Complejidad innecesaria para problemas simples
Asumir en vez de preguntar Se reescribe codigo cuando el bug era un typo

Reglas por lenguaje

El skill incluye referencias para reglas especificas:

  • references/typescript.md - TypeScript strict mode, testing, estructura
  • references/python.md - Type hints, mypy, pytest, ruff