info-iesvi / proyectodam-samuelvalleinclan

proyectodam-samuelvalleinclan created by GitHub Classroom
0 stars 3 forks source link

[Profe] Especificaciones de la fase de codificación #6

Open jlr2 opened 3 years ago

jlr2 commented 3 years ago

En la fase de codificación es probable que tengas que volver a atrás para realizar cambios en el diseño y/o análisis (modelo en cascada con realimentación dentro de esta primera iteración o sprint).

El proyecto se estructura en 2 componentes: frontend y backend.

La estructura de paquetes a usar puedes descargarla de Github Classroom. Está en un repositorio de nombre “ProjectTemplate”.

Documentación a entregar --> Cuando hagas la pull-request debes añadir un comentario indicando:

  1. Qué CUs, de los pedidos en este hito, tiene operativos la aplicación. En caso que no hubieras terminado alguno, explica lo que has realizado, indicando en qué estado se encuentra.
  2. Indicar los cambios realizados en las fases de análisis y diseño que has detectado en esta fase de codificación. Se pide una explicación general que permita ver de forma general estos cambios. En el siguiente apartado se indica cómo detallar estos cambios.

Documentación a entregar --> En la rama doc, readme.md, debes documentar:

  1. Configuraciones necesarias del IDE (Intellij) en el desarrollo de la app -librerías, parámetros, versión SDK …). Debe entregarse un pequeño tutorial paso a paso que permita poner en ejecución la aplicación entregada (de forma que un nuevo programador que se ponga con el proyecto pueda poner en marcha la aplicación haciendo uso del IDE).
  2. La app debe estar dockerizada y subida a dockerhub usando ci/cd (jenkins). Si se hiciera uso de otras apps como servidores de bases de datos, etc deben subirse también estas apps como imágenes docker. Deben documentarse los pasos a realizar para poner en ejecución la app (por ejemplo, descarga de imágenes, creación de contenedores, creación de red ...). La documentación pedida es un paso a paso que permita probar la app.
  3. Pruebas realizadas: documentar las pruebas realizadas con capturas de pantalla del funcionamiento de la app.
  4. Revisar la documentación de la fase de análisis y diseño con los cambios que hayas realizado en esta fase de codificación.

Código --> No olvides:

  1. Documentar cada clase con JavaDoc. Debes incluir un comentario general del uso de la clase y comentarios de cada atributo y método.
  2. El código debe incluir comentarios.