Reglas y estilo de Programación

📖 Reglas y Estilo de Programación

Este documento define los estándares de estilo de codificación y las reglas de programación utilizadas en este proyecto basado en FastAPI.

El objetivo de esta guía es asegurar un código consistente, legible y mantenible para facilitar la colaboración entre desarrolladores.

Esta guía está alojada en el Wiki de GitHub y sigue estándares de estilo ampliamente utilizados como:

🏷️ Regla	📜 Descripción
Nombres de Variables y Métodos	Usar nombres en inglés que sean descriptivos. Seguir `snake_case` para variables y funciones. Usar `PascalCase` para nombres de clases.
Formato del Código	Indentación de 4 espacios. Máximo 120 caracteres por línea. Espaciado consistente y líneas en blanco para legibilidad.
Comentarios y Documentación	Usar comentarios solo cuando sea necesario. Documentar funciones y clases con docstrings siguiendo PEP 257.
Estructura del Código	Organizar importaciones en bloques: 1️⃣ Librerías estándar 2️⃣ Dependencias externas 3️⃣ Módulos internos.
Control de Versiones	Seguir un formato claro para commits: `feat: Agregado nuevo endpoint` `fix: Corregido error en validación` `refactor: Mejorada la consulta`

✅ Buenas Prácticas	❌ Errores a Evitar
Definir rutas en routers separados.	No escribir lógica dentro de los controladores.
Utilizar Pydantic para validaciones de datos.	No realizar validaciones manuales en los controladores.
Usar Alembic para manejar migraciones.	No modificar la base de datos directamente sin control de versiones.
Configurar variables de entorno con dotenv.	No hardcodear credenciales en el código.

Para asegurar que el código sigue las reglas de estilo, se recomienda el uso de herramientas de formateo automático y linters.

🛠️ Herramienta	⚙️ Comando	📌 Descripción
Black	`black .`	Formateador automático de código según PEP 8.
Flake8	`flake8 .`	Linter que detecta errores de estilo.
isort	`isort .`	Ordena las importaciones automáticamente.

📌 Ejecutar todos los comandos a la vez:

black . && isort . && flake8 .

📌 Notas Finales

Se recomienda realizar revisiones de código periódicas para asegurar el cumplimiento de estas normas.
Esta documentación debe mantenerse actualizada según evolucione el proyecto.

📄 Última actualización: {{ 10/02/2025 }} 🚀