Docs & README
Cuando un cambio afecta la forma en que alguien instala, ejecuta, configura o utiliza el proyecto, actualiza README.md en el mismo cambio.
El README debe cubrir, brevemente:
- Qué es el proyecto (1-2 oraciones).
- Requisitos y pasos de instalación.
- Cómo ejecutar, probar y construir — comandos copiables.
- Configuración: cada variable de entorno con propósito y valor de ejemplo (nunca secretos reales).
- Ejemplos cortos de uso para las funciones principales.
Reglas:
- Edita solo las secciones que afecta el cambio; no reescribas todo el archivo.
- Verifica que cada comando que documentes realmente funcione.
- Inglés, oraciones cortas, sin lenguaje de marketing.