Skip to content

Instantly share code, notes, and snippets.

@fabdelgado
Forked from Villanuevand/README-español.md
Last active May 11, 2020 17:03
Show Gist options
  • Save fabdelgado/72612b7cd978e5a5910f3a2ebc24daf7 to your computer and use it in GitHub Desktop.
Save fabdelgado/72612b7cd978e5a5910f3a2ebc24daf7 to your computer and use it in GitHub Desktop.
Una plantilla para hacer un buen README.md. Inspirado en el gist de @PurpleBooth => https://gist.github.com/PurpleBooth/109311bb0361f32d87a2

Título del Módulo

En este párrafo debe describir la finalidad del módulo

Primeros pasos 🚀

Escriba aquí las instrucciones que permitirán a otro desarrollador o tester obtener este módulo y ponerlo en funcionamiento en un ambiente local.

Pre-requisitos 📋

Requisitos necesarios para poder ejecutar el proyecto

 - drupal 8.x.x
 - php 7.x.x
 - mysql 5.x.x
 - drush x.x.x

Instalación 🔧

_ Especifique los pasos para poder instalar el módulo y pasos secundarios que crea convenientes_

Ejemplo:

- Descargar el módulo
- Copiar en la carpeta: modules/custom/
- Activar el modulo con drush: drush en nombremodulo
- Limpiar cache: drush cr

Ejecutando las pruebas ⚙️

Explique detalladamente como ejecutar pruebas automatizadas para este sistema

Analice las pruebas end-to-end 🔩

Explique que verificación realizan estas pruebas y por qué

Pruebas de estilo de codificación ⌨️

Explique que verifican estas pruebas y por qué

Pruebas funcionales ⌨️

Explique paso a paso como realizar el testing funcional de este módulo

Ejemplo:

- Iniciar sesión en el sitio
- Dirigirse a crear contenido
- Seleccionar el tipo de contenido Noticias
- Al ingresar debe aparecer en el campo fecha X funcionalidad

Despliegue 📦

Agregue notas adicionales sobre como hacer deploy en los ambientes

Construido con 🛠️

Menciona las herramientas que utilizaste para crear tu proyecto

Wiki 📖

Puedes encontrar mucho más de cómo utilizar este proyecto en nuestra Wiki

Versionado 📌

Usamos SemVer para el versionado

Enlace aquí el archivo de versionado perteneciente al módulo Changelog

Autores ✒️

Aqui menciona todos los desarrolladores que estuvieron implicados o fueron consultados en la creación del módulo desde sus inicios

Licencia 📄

Este proyecto está bajo la Licencia (MIT) - mira el archivo LICENSE.md para detalles

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment