๐งฑ CONTRIBUTING#
Guia para contribuir sin degradar el estandar tecnico ni documental del laboratorio.
๐ Flujo recomendado#
- Trabaja en una rama dedicada.
- Implementa o ajusta el caso.
- Valida que el stack siga levantando con Docker.
- Actualiza la documentacion afectada en el mismo cambio.
- Usa un commit descriptivo y pequeno si es posible.
๐ฏ Regla principal del repositorio#
Si un caso se marca como OPERATIVO, debe resolver un problema real con suficiente evidencia. No basta con un endpoint trivial o una simulacion superficial.
๐งช Al agregar o profundizar un caso#
Cada cambio serio deberia considerar:
README.mddel caso actualizado;- documentacion de contexto, sintomas, diagnostico y trade-offs;
Dockerfileycompose.ymlfuncionales;- explicacion honesta de limites;
- observabilidad o diagnostico suficiente para sostener la narrativa tecnica.
๐ Reglas editoriales#
- Mantener consistencia con la familia documental raiz.
- Explicitar si algo es
OPERATIVO,DOCUMENTADO / SCAFFOLDoPLANIFICADO. - Evitar claims de paridad multi-stack que el codigo no soporte.
- No convertir un caso real en un demo pobre solo para "completar lenguajes".
๐งพ Convenciones utiles de commit#
| Prefijo | Uso |
|---|---|
feat: | nueva capacidad o nuevo caso operativo |
fix: | correccion funcional |
docs: | cambios solo documentales |
refactor: | reorganizacion sin cambio funcional principal |
chore: | mantenimiento, limpieza o tooling |
๐งน Artefactos que no deben versionarse#
- binarios compilados;
- caches temporales;
- archivos de salida de benchmarks;
- datos locales de ejecucion que no pertenezcan a la fuente del caso.
โ Validacion minima esperada#
Antes de proponer cambios:
- revisar
docker compose ... configen el caso afectado; - validar la sintaxis del lenguaje principal tocado;
- confirmar que la documentacion no quedo desalineada del estado real.