Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Improve project structure #35

Closed
wants to merge 15 commits into from
Closed

Feature: Improve project structure #35

wants to merge 15 commits into from

Conversation

Zyruks
Copy link

@Zyruks Zyruks commented Apr 8, 2024

Cambios Realizados 🎉

  • feat: Implementación de mejoras funcionales para optimizar la gestión de importaciones.
  • refactor: Reestructuración y optimización de componentes, estilos y rutas de importación para mejorar la organización del código.

Descripción de los Cambios

Se han realizado varios ajustes en la estructura del proyecto para mejorar la organización y mantenimiento del código. Esto incluye la reorganización de componentes, la actualización de rutas de importación para reflejar estas reorganizaciones y la centralización de estilos y assets para facilitar su gestión.

Implementación de Mejoras Funcionales:

  • Se han agregado archivos barrel en las secciones de componentes y librerías (/components y /lib). Esto permite simplificar las importaciones a lo largo del proyecto, facilitando un acceso más eficiente y organizado a componentes y utilidades.
  • Actualización de las rutas de favicon en la utilidad getMetaData, asegurando que los favicons sean correctamente referenciados siguiendo la nueva estructura de directorios.

Reestructuración y Optimización de Componentes y Estilos:

  • Los componentes Card, Link, y Particles, así como las secciones Hero y EventInfo, han sido reubicados dentro de directorios dedicados. Esta reorganización refleja una estructura de proyecto más clara y modular.
  • Se han movido las imágenes favicon al directorio public/assets/favicon y el archivo global.css a src/styles, centralizando los activos y estilos para un manejo más cohesivo.
  • Optimización de las declaraciones de importación en app/page.tsx, layout.tsx, y otros archivos afectados por la reubicación de componentes y la introducción de archivos barrel. Esto incluye la consolidación de importaciones de componentes y estilos, reflejando la nueva estructura del proyecto y mejorando la claridad del código.

Visuales (Opcional)

Antes de los cambios, la estructura de nuestros imports era más detallada y específica, lo que resultaba en declaraciones de importación más largas y menos manejables. Por ejemplo, cada componente o utilidad se importaba individualmente desde su ubicación exacta:

image
image

Con los cambios implementados, hemos adoptado una estructura de imports más eficiente y organizada gracias al uso de archivos barrel. Esto nos permite agrupar múltiples exports en un solo punto de acceso, simplificando significativamente las declaraciones de importación en todo el proyecto:

image
image

Lista de Verificación ✅

  • Mi código sigue el estilo de código de este proyecto.
  • Mi cambio requiere un cambio en la documentación.
  • He actualizado la documentación en consecuencia.

@fforres fforres mentioned this pull request Apr 9, 2024
4 tasks
@fforres
Copy link
Member

fforres commented Apr 9, 2024

Idem que este issue #34 (comment)
Conversaste estos features con alguien? Creo que están desconectados con el roadmap de desarrollo que llevamos, pero puedo no estar al corriente de tus conversaciones 🤔

@Zyruks
Copy link
Author

Zyruks commented Apr 9, 2024

Buen día @fforres,

Gracias por tu comentario. Efectivamente, no tuve la oportunidad de discutir estos cambios con el equipo previamente. Me encontré con el proyecto en GitHub, y dado que no encontré una guía específica sobre cómo contribuir, ni un enlace a un canal de comunicación como Discord, decidí enviar un PR con la esperanza de que pudiera ser de utilidad.

Entiendo perfectamente que cada proyecto tiene su propio roadmap de desarrollo y que las contribuciones externas deben alinearse con este. Mi intención fue aportar con una idea que consideré podría beneficiar al proyecto, pero soy plenamente consciente de que el equipo no tiene ninguna obligación de aceptar cambios que no se hayan discutido previamente.

Estoy más que dispuesto a dialogar sobre estos cambios para explicar mi punto de vista y entender mejor las necesidades del proyecto. Si consideran que mi contribución podría ajustarse de alguna manera para encajar mejor en el roadmap, estaré encantado de hacer las modificaciones necesarias.

Quedo a la espera de sus comentarios y abierto a cualquier sugerencia. Mi objetivo es colaborar de manera positiva con el proyecto.

@joseglego
Copy link
Member

Hola @Zyruks , @fforres ya te respondió pero no he visto más movimiento.

Estoy intentando retomar este repo y quiero darte mi opinión (MUCHA énfasis en mi opinión y que puede estar sesgada)

Como comentó @fforres lo ideal es discutir antes de hacer cambios. Siento que todos los cambios que hiciste fueron muy amplios y cambian mucho la arquitectura lo que podría ser un problema de llevar el código a prod y cómo intentamos que vayan las cosas en el proyecto.

Nuevamente, hay cosas que me gustan y cosas que no 😓 (si, nuevamente).

Lo primero, nuevamente me gustó un poco más de orden. Sobre todo porque el desorden fui yo. Gracias por eso. PERO siento que hay cambios muy opinionados y que simplemente son maneras distintas de trabajar. Sin duda, hay muchas cosas por mejorar ahorita en el repo. Pero, en este caso particular el approach a tomar podría ser un poco distinto.

Me gustaría saber qué opinas, si quieres discutirlo o si ya no estás interesado. disculpa la respuesta demorada. Quizás yo puedo usar tu branch como base. etc.

(Por esto te tipo de discusiones es que comentamos para juntarnos primero, porque has hecho trabajo que podría llegar o no a main, lo siento)

Podemos juntarnos o chatear por Discord.

@Zyruks Zyruks closed this by deleting the head repository Jun 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants