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

Tipado: Documentar con JSDoc // Pasar a typescript #187

Open
lazcanoluca opened this issue Oct 8, 2023 · 8 comments · May be fixed by #218
Open

Tipado: Documentar con JSDoc // Pasar a typescript #187

lazcanoluca opened this issue Oct 8, 2023 · 8 comments · May be fixed by #218
Labels
help wanted Extra attention is needed

Comments

@lazcanoluca
Copy link
Collaborator

Así tenemos sweet sweet intelisense en todo el proyecto, teniendo bien definidos los tipos de datos. Me parece que suma muchísimo, sobre todo para familiarizarse con el código y tener bien definidos los tipos (usuario, carrera, materia, etc).

Si aceptan la propuesta, yo ya la estoy trabajando, así que me pueden asignar.

@FdelMazo
Copy link
Owner

FdelMazo commented Oct 8, 2023

Tener el proyecto documentado y tipado me parece genial.

Entre jsdoc y typescript me parece que prefiero typescript (por flexibilidad y ser mas moderno y mas usado), pero si ya tenes mucho hecho con jsdoc, barbaro, vamos con eso!

@FdelMazo
Copy link
Owner

FdelMazo commented Oct 8, 2023

Gracias por la idea!

@lazcanoluca
Copy link
Collaborator Author

Sí, claro que si estás abierto a ir metiéndole TS, me parece infinitamente mejor. Sugerí JSDoc como para empezar. Ya está TS como dep? O habría que instalarlo?

@FdelMazo
Copy link
Owner

FdelMazo commented Oct 8, 2023

Typescript habria que agregarlo desde cero. Pero puede ser un buen esfuerzo! Si no lo arrancas vos, intento en algun momento meter el puntapie inicial

@FdelMazo FdelMazo changed the title Documentar con JSDoc Tipado: Documentar con JSDoc // Pasar a typescript Oct 10, 2023
@lazcanoluca
Copy link
Collaborator Author

Buenas! Sólo para comentar que empecé con esto, no sé qué tan rápido avance porque se me vienen los parciales pero bueno.

¿Abro una PR en draft para ir trackeando el progreso? No sé bien cómo se maneja eso en un proyecto colaborativo 👀.

¿Me habías mandado invite para colaborar? Se me re pasó y no la acepté a tiempo 🤦🏻‍♂️.

PD: ¿hay algún motivo particular por el cual las correlativas están almacenadas como string, y no array?

@FdelMazo
Copy link
Owner

Genial Luca!

Del ritmo ni te preocupes, este proyecto es un hobby, las cosas no tienen urgencia.

¿Abro una PR en draft para ir trackeando el progreso? No sé bien cómo se maneja eso en un proyecto colaborativo 👀.

Como vos prefieras. Podes armar tu branch y cuando sientas que necesitas feedback, armar un PR en draft. Yo mucho no voy a meterme a menos que me pidas review/ayuda con algo

El invite para colaborar (que te lo acabo de re-enviar) te lo mando para que lentamente haya mas gente en el fiuba map, y asegurarnos que no haya una sola persona de la que dependa todo, pero si querés podes rechazar el invite sin compromiso. Obviamente tiene su dosis de responsabilidad (no pushear cosas a master sin consenso), pero agrega la comodidad de no tener que estar forkeando todo el tiempo.

Si se te ocurre alguien para meter al proyecto que pueda dar una mano con los dos planes que faltan meter, pinguealo! Mientras mas gente, mejor

Las correlativas son un string porque cuando arranque el proyecto en vez de usar un json usaba un csv como datos, y no se me ocurrio nada mejor. Basicamente, legacy code. Un array me parece mucho mas apropiado!

@salluzziluca
Copy link
Collaborator

Buenass, todo bien? Me gustaria colabrar, por lo que entendí la idea es ir pasando toda la codebase a ts, no? Justo andaba aprendiendo y puede ser una buena forma de familiarizarme con el lenguaje. El unico que tema es que nos vamos a confundir entre Luca y Luca ajajajja

@lazcanoluca
Copy link
Collaborator Author

Perfecto Fede! Gracias!

Las correlativas son un string porque cuando arranque el proyecto en vez de usar un json usaba un csv como datos, y no se me ocurrio nada mejor. Basicamente, legacy code. Un array me parece mucho mas apropiado!

Jajaja está perfecto, tiene sentido.

@salluzziluca grande! Voy a abrir una draft PR, con algunos tipos que definí. De ahí los mejoramos para que modelen lo mejor posible todo. Con esa base, podemos ir adaptando el resto sin miedo, en una branch aparte. Sounds good @FdelMazo ?

@FdelMazo FdelMazo added the help wanted Extra attention is needed label Aug 8, 2024
@lopezac lopezac linked a pull request Aug 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants