Convenciones del estudio (Estándar TinyCorn Studio)
Aplica para cada repositorio/herramienta del estudio, desde la inicialización hasta el mantenimiento.
Idioma
- Comunicación con el usuario: vietnamita.
- Código, identificadores, mensajes de commit, nombres de rama: inglés.
- README, CHANGELOG, notas de publicación: vietnamita.
Estructura mínima del repositorio
<repo>/
├── README.md # obligatorio
├── CHANGELOG.md # obligatorio (Keep a Changelog)
├── LICENSE # normalmente MIT
└── .gitignore # obligatorio
README.md debe incluir las secciones
- Introducción (1–2 frases, qué hace la herramienta, para quién)
- Requisitos del sistema
- Compilar / ejecutar
- Características principales (agrupadas)
- Atajos de teclado (si tiene interfaz de usuario)
- Arquitectura / estructura de directorios
- Configuración (UserDefaults, env, archivo de configuración...)
- Limitaciones conocidas
- Historial de versiones (resumen, detalle en CHANGELOG)
- Descarga (enlace a la última GitHub Release — no guardar el instalador en el repositorio)
Git
.gitignoremínimo:.build/,dist/,node_modules/,.DS_Store, directorios de recursos generados automáticamente al compilar.- No commitees: instaladores (DMG/ZIP), salida de compilación, secretos/tokens.
- Mensaje de commit: 1 línea, modo imperativo, en inglés, describe completamente la característica/corrección. Ejemplo:
Add folder view to Changes tab. - Commit por cada característica completa; solo commitea cuando el usuario lo solicite o cuando hayas confirmado la característica.
- Rama:
mainsiempre en estado publicable; las características se desarrollan en ramas separadas, merge con--ff-onlyal finalizar. - Versión: SemVer, declarada en un solo lugar (ej.
VERSIONenmake-app.sh), no esparcida en múltiples archivos.
Documentación
- README + CHANGELOG se actualizan al mismo tiempo que la característica (no después).
- Cada publicación incluye: tag anotado
vX.Y.Z+ GitHub Release con notas de publicación en vietnamita (ver habilidadrelease-flow). - Las notas sobre decisiones de diseño complejas se registran en el código o en la sección "Arquitectura" del README.
Calidad
- Antes de informar que está completo: compilar/probar de nuevo, verificar con datos reales o en un sandbox.
- UI: vista previa antes de aplicar (ver habilidad
ui-preview-first). - No pruebes escrituras/commits sobre datos reales del usuario: usa una copia en sandbox.
- Después de la prueba, limpia el sandbox/temp, no dejes residuos en el repositorio.
Lista de verificación para repositorio nuevo
-
git init+.gitignoreestándar - README según la estructura anterior
- CHANGELOG con sección
[0.1.0] - LICENSE (MIT)
- Script de compilación (make-app.sh o equivalente) + DMG/instalador
- GitHub remoto + push de
main - Primera publicación con el instalador adjunto
- La habilidad
release-flowya se conoce para usarse en ocasiones posteriores