Skip to content

Pautas sugeridas al escribir código

Daniel Diaz edited this page Aug 8, 2024 · 2 revisions

General

  • Todo el código, incluyendo los comentarios, debe estar escrito en español. Se permite el uso de inglés solo para términos ampliamente reconocidos en programación o que sean convenciones de los frameworks utilizados.
  • Los nombres de las variables, funciones y otros elementos deben ser descriptivos, de manera que no sea necesario comentar para explicar su propósito; esto debe reflejarse en sus nombres.
  • Se debe evitar utilizar tipos implícitos en las declaraciones de TypeScript siempre que sea posible.
  • Todas las funciones deben estar documentadas al inicio, proporcionando una descripción clara de su propósito, así como detalles sobre sus parámetros y el valor que retornan.

Funciones

  • Idealmente, las funciones deben tener menos de 25 líneas de código. Ninguna función debe exceder las 100 líneas; si se alcanza este límite, es necesario refactorizar la función para mejorar su legibilidad y mantenimiento.

Organización y Estructura

  • Modularidad: Divide el código en módulos o archivos según su funcionalidad. Esto facilita la navegación y el mantenimiento del código.
  • Convenciones de Nombres: Utiliza una convención de nombres consistente para variables, funciones, clases y archivos. Por ejemplo, emplea camelCase para variables y funciones, y PascalCase para clases.
  • Estructura de Carpetas: Organiza los archivos en las carpetas ya definidas según su propósito.

Control de Versiones

  • Commits Significativos: Realiza commits con mensajes claros y descriptivos sobre los cambios realizados.
  • Ramas de Desarrollo: Utiliza ramas para desarrollar nuevas funcionalidades o corregir errores, y fusiona con la rama principal una vez que se hayan completado y probado los cambios.