Pautas para la creación de código¶

En Legalys estamos más interesados en crear código que siga los valores y prioridades técnicas antes definidos, que en seguir algún estándar específico. El formato del código es solo una pequeña parte de lo que significa escribir código: un código mal formateado se puede arreglar con linters, pero un código que no se pensó lo suficiente no puede arreglarse con ninguna herramienta (aún la tecnología no llega a eso).

Dicho esto, las directrices de código que utilizamos son las siguientes:

Haz tu mejor esfuerzo por ajustarte al estilo de codificación que ya existe en el repositorio. Eso significa que nos gusta.
Escribimos variables y comentarios en inglés.
Usamos espacios en vez de tabs.
Usamos 4 espacios para indentar Python y 2 espacios para JavaScript, HTML y CSS.
Siempre linteamos el código antes de crear un Pull Request y nos aseguramos de que cada cambio no tenga errores de formato. Esto lo verifica automáticamente el sistema de Integración Continua. Para Python usamos flake8, isort y black; para JavaScript usamos ESLint. Por regla, estas herramientas ya vienen configuradas en los repositorios.
Eres libre de usar el editor de tu preferencia mientras cumplas las reglas de estilo. Nosotros usamos VS Code y PyCharm.
Escribe comentarios: son buenos para el feedback.
Realiza tests unitarios: son importantes para garantizar la calidad del software.
No crees Pull Requests gigantes con un montón de funcionalidad; mantén los PR enfocados y pequeños.
Crea el Pull Request hacia la rama develop en nuestros repos.
¡Diviértete, todo problema tiene solución! 😎

Cómo crear un Pull Request

En la siguiente guía puedes ver el procedimiento paso a paso: ¿Cómo crear un Pull Request?