-
Notifications
You must be signed in to change notification settings - Fork 0
Desarrollo
Aquí puedes añadir una introducción general a las convenciones si lo deseas, antes de entrar en los detalles de cada tecnología.
Para este proyecto se utilizará HTML Semántico con el objetivo de organizar el contenido de manera más clara, accesible y eficiente.
Se dará prioridad al uso adecuado de etiquetas como <header>, <nav>, <main>, <section>, <article> y <footer>, evitando el uso excesivo de elementos genéricos como <div>, salvo en situaciones en que sea indispensable.
En cuanto a la escritura de estilos CSS, el equipo ha decidido implementar la metodología BEM (Block Element Modifier).
Esta convención de nomenclatura permitirá mantener el código ordenado, predecible y fácil de escalar a medida que el proyecto crezca.
Las clases seguirán el formato bloque__elemento--modificador, promoviendo una estructura clara en el HTML y facilitando la comprensión entre todos los desarrolladores del equipo.
Para el desarrollo backend con Python y Django, se seguirá la convención oficial de estilo PEP8. Esto permitirá mantener un código limpio, uniforme y fácil de mantener dentro del equipo. Las principales reglas que aplicaremos serán:
-
Archivos y carpetas: nombres en minúscula, separados por guiones bajos (
user_profile.py). -
Clases: PascalCase (
UserProfile,ProductView). -
Funciones, métodos y variables: snake_case (
get_user_data(),user_email). -
Constantes: MAYÚSCULAS_SEPARADAS_POR_GUIONES_BAJOS (
MAX_USERS).
Los archivos se nombran en minúscula y separados por puntos:
- Módulo:
nombre.module.ts - Componente:
nombre.component.ts/html/scss - Servicio:
nombre.service.ts - Interface:
nombre.interface.ts - Pipe:
nombre.pipe.ts - Directiva:
nombre.directive.ts - Modelo:
nombre.model.ts
-
Clases: PascalCase (
UserService,LoginComponent) -
Variables, métodos y propiedades: camelCase (
userName,getUserData()) -
Selectores de componentes: prefijo + nombre en kebab-case (
app-user-profile) -
Rutas: kebab-case (
/user-profile)
- Una clase pública por archivo
.ts. - Organizar archivos en carpetas según su funcionalidad.
- Propiedades privadas: se puede usar prefijo
_(opcional).