En esta sección se establece los contenidos mínimos en el README para la descriptivos de un repositorio Github para la OAS.
├── Nombre de Repositorio
│ └── Descripción de Repositorio
├── Especificaciones Técnicas
│ ├── Tecnologías Implementadas y Versiones
│ ├── Variables de Entorno
│ ├── Ejecución del Proyecto
| │ ├── Ejecución Docker
| │ ├── Ejecución docker-compose
│ ├── Ejecución Pruebas
└── Estado CI
└── Modelo de Datos
└── LicenciaSe debe nombrar el repositorios de acuerdo al lineamiento del capítulo anterior nombramiento de repositorios
Se debe especificar el propósito o la funcionalidad del repositorios en la descripción inicial, como se observa en la imagen siguiente:
Se debe documentar los aspecto técnicos del componente de software como: Tecnologías Implementadas y Versiones, Instalación, Variables de Entorno, Ejecución del Proyecto, Modelo de Datos, pero estas no son las únicas; puedes agregar secciones para la ejecución del docker o puertos y endpoint para mayor descripción. La idea principal es brindar una introducción para los desarrolladores, devops y equipos de infraestructuras acerca del componente de software que alberga dicho repositorio.
Se crean links o enlaces del fabricante oficial acerca las tecnologías implementadas y en ocasiones se proporciona su versión específica
Define las variables implementadas y una breve descripción del valor que almacenan.
Define la serie de pasos y comandos para ejecutar el repositorio en ambiente local.
Define la serie de pasos y comandos para ejecutar el repositorio en ambiente dockerizado.
Define la serie de pasos y comandos para ejecutar el repositorio en ambiente dockerizado.
Son links que dirigen hacia los resultado del sistema de integración continua.
Los modelos de datos, mockups o modelos de interfaces gráficas por ser imágenes tan extensas, se establece crear enlaces a las imágenes, para que no extiendan el contenido del readme.
Se debe definir la licencia del repositorio, como se observa en la imagen siguiente:
