Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save wolfcito/ed0c6ee31169ae93a7c3848e1162ad89 to your computer and use it in GitHub Desktop.
Save wolfcito/ed0c6ee31169ae93a7c3848e1162ad89 to your computer and use it in GitHub Desktop.
Buenas prácticas / lineamientos buenos al momento de programar

Buenas prácticas

  1. Evita en lo posible dejar código que no se utiliza: Eliminar código no utilizado es una excelente práctica. Puede ayudar a reducir la complejidad y el mantenimiento innecesario.

  2. Comenta tu código cuando sea muy extenso y/o complejo de entender: Comentar el código complejo o poco intuitivo puede facilitar la comprensión para otros desarrolladores. Sin embargo, es mejor escribir código autoexplicativo siempre que sea posible.

  3. Utiliza software para control de versiones (GIT): El uso de control de versiones como Git es fundamental para rastrear y gestionar cambios en el código.

  4. No versionar código comentado o con errores: No debe incluirse código comentado ni código que se sepa que tiene errores en el control de versiones.

  5. Al hacer un commit poner un comentario descriptivo de lo que se está versionando: Los comentarios de commit deben ser descriptivos y explicar qué cambios se han realizado. Podrías convenir con tu equipo utilizar los conventional commits https://www.conventionalcommits.org/en/v1.0.0/#summary

  6. Al trabajar con clases/componentes utilizar nomenclatura como "camelCase": En un proyecto es necesario tomar decisiones para estandarizar y agilizar el desarrollo. Como por ejemplo la nomenclatura camelCase es una práctica común y recomendable para nombres de clases y componentes.

  7. Al trabajar con métodos, atributos, variables utilizar nombres en formato lowerCamelCase: Utilizar lowerCamelCase para nombres de métodos, atributos y variables es una buena práctica de nomenclatura.

  8. Al trabajar con constantes utilizar nombres descriptivos en mayúscula separadas con guiones bajos si es necesario: Usar nombres descriptivos en mayúscula para las constantes, como "CONSTANTE_IMPORTANTE," ayuda a identificar su importancia y función.

  9. Si se requiere paths para URL(s) utiliza nombres descriptivos con minúsculas y separados con guiones medios: Utilizar nombres descriptivos y minúsculas en las URL es una práctica recomendable para mejorar la legibilidad y el SEO.

  10. En lo posible, asocia un componente a una sola vista: Aplica de manera coherente el principio de responsabilidad única, para mantener la asociación uno a uno entre componentes y vistas puede simplificar el diseño y la estructura del código.

  11. Cuando son recursos asociados, utiliza nombres descriptivos haciendo referencia a su funcionalidad: Nombrar los recursos asociados de manera descriptiva ayuda a entender su función y contexto.

  12. Para validar funcionalidad, métodos, API, librerías, etc., utiliza una branch denominada "Test": La creación de una rama (branch) de pruebas es una práctica sólida para validar funcionalidad sin afectar el código principal.

Siguiendo estas buenas prácticas, tu desarrollo de software debería ser más eficiente y mantenible, y facilitará la colaboración con otros desarrolladores en tu equipo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment