Breve descripción del proyecto o componente que vive en este repositorio.
Este repositorio fue creado a partir del template de la organización utn-fra-lse. Al crear un repo nuevo desde el template, asegurate de:
- Cambiar el nombre y descripción del repositorio desde Settings → General
- Actualizar este README — reemplazá el título, descripción y secciones que no apliquen
- Configurar los branch rulesets si no se aplicaron automáticamente desde la organización (ver sección de flujo de trabajo)
- Asignar el repositorio al proyecto de GitHub Projects de la organización si corresponde
Este repositorio sigue una convención de dos ramas principales:
| Rama | Propósito |
|---|---|
main |
Código estable. Nunca se pushea directo. Solo acepta merges via PR aprobada por un docente. |
develop |
Rama de integración. Cualquier becario puede hacer merge via PR sin requerir aprobación. |
Las ramas de trabajo se crean a partir de develop con nombres descriptivos:
feature/nombre-de-la-funcionalidad
fix/descripcion-del-bug
docs/lo-que-se-documenta
[rama feature] → PR → [develop] → PR (aprobación docente) → [main]
-
Creá tu rama desde
develop:git checkout develop git pull origin develop git checkout -b feature/mi-feature
-
Trabajá en tu rama y commiteá con mensajes descriptivos:
git commit -m "feat: agrega validación de formulario" -
Abrí una Pull Request hacia
developcuando terminés -
Una vez integrado en
developy validado, un docente abre la PR haciamain
⚠️ Nunca pushear directamente amainni adevelop. Siempre trabajar desde ramas propias y abrir PR.
Usamos una convención simple basada en prefijos:
| Prefijo | Cuándo usarlo |
|---|---|
feat: |
Nueva funcionalidad |
fix: |
Corrección de bug |
docs: |
Cambios en documentación |
refactor: |
Refactorización sin cambio de comportamiento |
chore: |
Tareas de mantenimiento, dependencias |
| Rol | Responsabilidades en GitHub |
|---|---|
| Docentes | Aprueban PRs hacia main, administran la organización |
| Becarios | Crean ramas, abren PRs hacia develop, participan en revisiones |
- Organización en GitHub
- Tablero del laboratorio (GitHub Projects)
- Repositorio de gestión operativa (issues, documentación, inventario)
Agregá acá cualquier información específica del proyecto: dependencias necesarias, cómo correr el proyecto localmente, contexto relevante, etc.