docs: actualizada la documentación de desarrollo

coz-eduardo-hernandez · Jul 11, 2023 · 8416e02 · 8416e02
1 parent caecc98
commit 8416e02
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 0 deletions.
diff --git a/docs/LEEME.es.md b/docs/LEEME.es.md
@@ -4,3 +4,8 @@ Calabozo Pixelado Dominicano es un videojuego libre de calabozos disponible bajo
 
 Corre en Android, iOS, y sistemas operativos de escritorio
 
+## Derechos de autor
+Copyright (C) 2023 Eduardo Hernández
+Este es un programa libre bajo la GNU General Public License en su versión 3, o si lo desea una versión posterior
+Para los términos completos vea [LICENCIA.txt](../LICENCIA.txt) o vaya a https://www.gnu.org/licenses
+
diff --git a/docs/README.en.md b/docs/README.en.md
@@ -3,3 +3,9 @@
 Calabozo Pixelado Dominicano is a Free Software roguelike available under the GPLv3 license
 
 It runs on Android, iOS, and Desktop platforms
+
+## Copyright
+Copyright (C) 2023 Eduardo Hernández
+This is Free Software under the GNU GNU General Public License version 3, or at your option a later version
+For the full terms see [LICENSE.txt](../LICENSE.txt) o go to https://www.gnu.org/licenses
+
diff --git a/docs/confirmar.es.md b/docs/confirmar.es.md
@@ -1,3 +1,4 @@
+# Mensajes de confirmación para control de versiones
 Los mensajes de confirmación tienen que seguir el formato [convencional v1.0.0](https://www.conventionalcommits.org/es/v1.0.0/):
 
 `<tipo>[alcance opcional]: <descripción>`
@@ -33,3 +34,9 @@ Finalmente, hay tipos que se aplican a cualquier archivo o función:
 - sync   : incluye nuevos cambios desde el origen
 
 Las solicitudes de extracción en GitHub siguen el formato de <tipo>: <descripción>
+
+## Derechos de autor
+Copyright (C) 2023 Eduardo Hernández
+Este es un programa libre bajo la GNU General Public License en su versión 3, o si lo desea una versión posterior
+Para los términos completos vea [LICENCIA.txt](../LICENCIA.txt) o vaya a https://www.gnu.org/licenses
+
diff --git a/docs/contribuyendo.es.md b/docs/contribuyendo.es.md
@@ -0,0 +1,13 @@
+# Cómo contribuir a Calabozo Pixelado Dominicano
+
+Si experimentas algún error, o tienes alguna idea, eres bienvenido a hacer un reporte en https://github.com/coz-eduardo-hernandez/calabozo-pixelado-dominicano/issues
+
+Por el momento no estoy aceptando las solicitudes extracción, al menos hasta que determine la mejor forma de manejarlas
+
+Por el momento no estoy traduciendo el programa a otros lenguajes, al menos hasta que determine la mejor forma de hacerlo
+
+## Derechos de autor
+Copyright (C) 2023 Eduardo Hernández
+Este es un programa libre bajo la GNU General Public License en su versión 3, o si lo desea una versión posterior
+Para los términos completos vea [LICENCIA.txt](../LICENCIA.txt) o vaya a https://www.gnu.org/licenses
+
diff --git a/docs/desarrollo.es.md b/docs/desarrollo.es.md
@@ -144,3 +144,8 @@ miembros de la escena a la que se apunta
 
 Para saber más de cómo funciona el juego, revisa el código de la escena que te interesa :)
 
+## Derechos de autor
+Copyright (C) 2023 Eduardo Hernández
+Este es un programa libre bajo la GNU General Public License en su versión 3, o si lo desea una versión posterior
+Para los términos completos vea [LICENCIA.txt](../LICENCIA.txt) o vaya a https://www.gnu.org/licenses
+
diff --git a/docs/pruebas.es.md b/docs/pruebas.es.md
@@ -0,0 +1,22 @@
+# Pruebas del programa
+
+Se alienta la creación de pruebas unitarias y de integración, pero no es un requisito. Esta recomendación es mucho más fuerte para pruebas de errores pasados y para código nuevo. Sin embargo, asegurarse que los cambios pasen las pruebas actuales si es necesario
+
+Las pruebas unitarias están en los directorios <módulo>/src/utest. Estas son pruebas que prueban las funciones privadas y protegidas de una clase de manera aislada; no depende de que ningún componente externo como otras clases, archivos, información transmitida por una red o interacción con el usuario. Si uno de estos elementos es necesario para la prueba, se simula
+
+Las pruebas de integración están en los directorios <módulo>/src/itest. Estas envuelven al menos dos componentes internos o externos
+
+Las pruebas unitarias deben correr antes que las de integración. Se recomienda que se corran las pruebas unitarias antes de cada confirmación, y las pruebas de integración antes de cada solicitud de extracción
+
+Una forma de crear las pruebas para código que no esta preparado para las mismas es:
+
+1. Crea una abstracción (sea una interface o clase abstracta) de cada componente a probar
+2. Agrega una forma de inyectar la dependencias (preferiblemente en el constructor, sino una función 'setter' de la instancia). No se debe agregar inyección de dependencias sólo para las pruebas, pero de todas maneras es probable que el código sea mejor si se usan
+3. Crea pruebas unitarias para lo que quieres, inyectando cualquier dependencia con una imitación
+4. Crea pruebas de integración
+
+## Derechos de autor
+Copyright (C) 2023 Eduardo Hernández
+Este es un programa libre bajo la GNU General Public License en su versión 3, o si lo desea una versión posterior
+Para los términos completos vea [LICENCIA.txt](../LICENCIA.txt) o vaya a https://www.gnu.org/licenses
+