Para tener una buena visibilidad sobre cada proyecto es importante que el readme contenga todos loas aspectos importantes como el stack tecnológico, configuración, instalación, comandos mas utilizados, etc
Puedes descargar la plantilla aquí
Título y descripción del proyecto
| Nombre | Versión | |
|---|---|---|
| Lenguaje | 1.0 | |
| Framework | 1.0 | |
| Base de datos | 1.0 | |
| Servicio de caché | ||
| Servicio de cola de trabajos |
Prerrequisitos necesita el proyecto
Escribe o enlaza cómo se consiguen las claves necesarias para iniciar el proyecto
Scripts de instalación
Pasos necesarios para aprovisionar la aplicación, ej: ejecutando una seed o descargado un backup de base de datos
Scripts de importación o migraciones
Escribe los comandos necesarios para iniciar la aplicación
Script de inicio
| Enlace | |
|---|---|
| Producción | www.example.org |
| Staging | www.example.org |
| Integración continua | www.example.org |
| Monitorización | www.example.org |
| Wiki | www.example.org |
| Drive | www.example.org |
| Slack | www.example.org |
| Proceso de despliegue | www.example.org |
| Claves y permisos | www.example.org |
Algún consejo importante o cualquier problema recurrente que encuentres como desarrollador agrégalo aquí o pon un enlace a la wiki
Usuario de prueba por defecto o cómo crearlo
Script de despliegue a staging
Scripts de test
Script de validador de guía de estilos
ej: bundle exec rubocop, npm run eslint, mix dogma