- Normas de Codificación
- Políticas de Mensajes de Commits
- Estrategia de Ramificación
- Políticas de Versionamiento
- Clockify
- Despliegue
Este índice refleja las secciones y subsecciones del contenido proporcionado en el documento. Cada enlace te llevará directamente a la sección correspondiente para una navegación rápida y conveniente. Si necesitas más ayuda, no dudes en preguntar.
- Nomenclatura de Clases: Deben comenzar con una letra mayúscula y usar camelCase. Ejemplo: MiClase
- Nomenclatura de Variables: Deben comenzar con una letra minúscula y usar camelCase. Ejemplo: miVariable
- Nomenclatura de Métodos: Deben comenzar con una letra minúscula y usar camelCase. Ejemplo: miMetodo()
- Nomenclatura de Constantes: Deben estar en mayúsculas y usar guiones bajos para separar las palabras. Ejemplo: MI_CONSTANTE
- Nomenclatura de Documentos: Deben comenzar con una letra mayúscula y usar camelCase con extensión .md. Ejemplo: MiDocumento.md
- Indentación: Será de una tabulación.
- Longitud de Línea: Se recomienda que las líneas de código no superen los 80 caracteres de longitud para mejorar la legibilidad.
- Comentarios: Se deben incluir comentarios descriptivos en el código para explicar su funcionamiento, especialmente en partes complejas o críticas. Los comentarios deben estar en inglés y seguir un estilo claro y conciso.
- Importaciones: Se deben evitar las importaciones de paquetes completos y solo importar las clases específicas necesarias. Además, las importaciones deben agruparse y ordenarse de manera lógica.
- Formato de Archivos: Los archivos Java deben tener una estructura clara y consistente, con una declaración de paquete, seguida de importaciones y luego la definición de clases y métodos.
Los mensajes de commits seguirán la siguiente estructura:
[Tipo]: Descripción en inglés
Tipos :
- [feat] : Indica que el commit está introduciendo una nueva característica o funcionalidad al proyecto. (Código)
- [edit] : Indica que se han realizado modificaciones o ediciones sin introducir nuevas características o funcionalidades. (Código)
- [fix] : Indica que se ha corregido un error o un problema específico en el código. (Código)
- [wip] : Indica que el trabajo está en curso ("Work In Progress") y aún no está completo. (Código)
- [docs] : Indica que los cambios realizados están relacionados con la documentación del proyecto. (Documentación)
- [refactor] : Indica que se han realizado cambios en el código con el objetivo de mejorar su estructura, claridad, rendimiento o mantenibilidad sin modificar su comportamiento funcional externo. (Código)
Para cada issue tendrá una rama propia y será implementada en su propia rama, así es fácil saber qué código implementa qué issue, con solo buscar el número de issue en las ramas. Las ramas seguirán el siguiente formato :
Feature/<descripción del issue>/<número de issue>
Una vez que se haya implementado y revisado correctamente el issue definido, se realizará un pull-request a la rama develop.
Para cada release crearemos una rama propia. Las ramas seguirán el siguiente formato :
Release/<versión del proyecto>
La rama main se actualizará cada vez que se haga una release.
Para arreglar los bugs inesperados en medio de la producción, existirá una rama llamada hotfix. Hotfix es similar a la rama releases solo que será utilizada para resolver bugs críticos en una versión o errores no planeados en la producción.
Vamos a seguir el formato de versiones X.Y.Z. La primera versión será la 1.00.
Cuando se lanza una versión mayor (major release), incrementaremos el número X de la versión y, si existen, pondremos a cero los números Y y Z.
Release/2.0.0
Para las versiones menores (minor release), mantendremos el número X, aumentaremos Y y resetearemos Z, que es la versión de parche (patch).
Release/2.1.0
Finalmente, cuando lanzamos una versión de parche (patch release), incrementamos Z.
Release/2.1.1
Los mensajes de clockify seguirán la siguiente estructura:
[Tipo]: Descripción en inglés
Tipos :
- [meet] : Indica que ese tiempo se ha dedicado en una reunión.
- [conflics] : Indica que ese tiempo se ha dedicado arreglando conflictos.
- [work] : Indica que ese tiempo se ha dedicado trabajando en alguna tarea
El despliegue de la aplicación se encuentra en la siguiente URL: