Guías de desarrollo
Esta sección contiene guías completas para desarrolladores que trabajan en omegaUp.
Enlaces rápidos
-
Estándares de codificación, guías de estilo y mejores prácticas para PHP, TypeScript y Python.
-
Cómo escribir y ejecutar pruebas para PHP, TypeScript y Cypress E2E.
-
Comprender los patrones DAO/VO y las mejores prácticas de interacción con bases de datos.
-
Desarrollo de componentes Vue.js e integración de Storybook.
-
Comandos y atajos de desarrollo comunes.
Flujo de trabajo de desarrollo
- Configure su entorno - Ejecute Docker
- Lea las pautas de codificación - Comprenda nuestros estándares
- Escribir pruebas - Asegúrese de que su código funcione
- Enviar un PR - Contribuya con sus cambios
Principios clave
Tipo Seguridad
- Todo el código debe declarar tipos de datos.
- TypeScript para interfaz
- Salmo para PHP
- mypy para Python
Pruebas
- Todos los cambios de funcionalidad deben incluir pruebas.
- Las pruebas deben pasar el 100% antes de comprometerse.
- Escribe pruebas primero cuando sea posible.
Calidad del código
- Siga las reglas de linting automatizadas
- Utilice cláusulas de protección en lugar de condicionales anidados
- Minimizar el uso nulo/indefinido
- Eliminar el código no utilizado (no comentarlo)
Documentación relacionada
- Descripción general de la arquitectura - Diseño del sistema
- Referencia de API - Documentación de API
- Comenzando - Guía de configuración y contribución
¿Listo para codificar? ¡Comience con las Pautas de codificación!