El método
| Concepto | Fundamento |
|---|---|
| El README se dirige a quien desconoce el proyecto | Es el único documento que se consulta antes de decidir si continuar. Un README redactado para el docente deja de cumplir su función ante cualquier otro lector |
| Las validaciones del pipeline deben documentarse | Constituyen la evidencia metodológica de mayor valor y no son observables desde el exterior del repositorio |
| Una versión es una referencia inmutable | Permite identificar un estado concreto del producto y recuperarlo de forma exacta en cualquier momento posterior |
| Las notas generadas son un borrador | Enumeran las pull requests incorporadas; el lector necesita saber qué permite hacer la versión que la anterior no permitía |
| Alcanzar la versión 1.0 es una decisión de alcance | No significa desarrollo concluido, sino cumplimiento íntegro del alcance comprometido |
| La apertura de issues no requiere permisos de escritura | De ahí que la revisión cruzada funcione sin conceder acceso al repositorio |
El vocabulario de la unidad
| Concepto | Definición |
|---|---|
| README | Documento de entrada del repositorio. Se consulta en menos de un minuto |
| Etiqueta | Referencia inmutable asignada a un commit determinado |
| Release | Publicación de una etiqueta con título y notas, dirigida a personas |
| Versionado semántico | MAYOR.MENOR.PARCHE: cambio incompatible, funcionalidad añadida, defecto corregido |
| Notas de versión | Descripción de lo que la versión permite hacer frente a la anterior |
| Insignia | Imagen que refleja en tiempo real el estado del pipeline en el README |
| Auditoría | Revisión del rastro completo de un proyecto contra una relación de criterios acordada, comunicada mediante issues |
Ya deberías ser capaz de
- Escribir un README dirigido a quien no conoce el proyecto ni a su autor.
- Etiquetar una versión y publicarla como release con sus notas.
- Explicar el significado de las tres cifras del versionado semántico.
- Auditar un repositorio ajeno contra la definición de terminado y comunicar los hallazgos mediante issues.
- Identificar en el rastro de desarrollo propio los elementos que se evalúan en la defensa.