En este capítulo se revisarán los estándares declarados por Elun para las dimensiones de documentación de código y correcta utilización del gestor de versiones.
Es importante que el constructor de piezas de software se preocupe no solo de cumplir con las expectativas de código limpio declarados en el capítulo 2. Programación sino también preocuparse que el código sea descriptivo y comentado adecuadamente pensando en que el código podría se intervenido por otra persona.
Tanto los métodos como los atributos deben poseer nombres descriptivos y fáciles de reconocer en la lógica del mismo código. Sumado a lo anterior, los métodos y las clases deben poseer una descripción comentada de qué es lo que hace, cuales son sus inputs y sus outputs.
Junto con lo anterior, es necesario seguir los estándares Docstring correspondientes a cada lenguaje de programación.
Elun exige para todos sus proyectos la utilización de Git para mantener el código versionado y ordenado. Junto con lo anterior se debe implementar las siguientes buenas prácticas de manera complementaria:
Los nombres oficiales que deben tener las ramas son:
Es responsabilidad del constructor y/o proveedor el mantener el gestor de versiones sano y actualizado. En términos prácticos se solicita: