javierbrk
commented
6 years ago Concretamente creo que tenemos que pensar en qué documentación resultaría útil para entender el proyecto y poder hacer un aporte.
Tal como habláramos en la reunión es necesario comentar al menos que es cada clase y sus responsabilidades, al igual que los métodos mas importantes. Por otra parte creo que en la wiki se podría comentar como esta estructurado el código, diagramas de clase y de secuencia serán bienvenidos. Esto podría ir en una carpeta "doc" desde donde podamos alimentar a la wiki.
Si están de acuerdo con estos lineamientos podríamos ir armando algo, lo pueden ir concentrando en el repo de alguno de ustedes y lo vamos revisando desde allí.
Javier, con mis compañeros Guadalupe Vocos y Juan Cruz Diaz nos ofrecemos a realizar el comentariado (si es válido decirlo así) del código, si es de tu agrado y agrega valor.
El primer paso sería establecer reglas de como se va a llevar a cabo, haríamos una breve descripción, explicando que se va a comentar y que no, como lo vamos a comentar, y donde (si en el código, o en documento aparte como habías sugerido).
Si nos das el ok, te preparamos estas reglas de comentariado, para que las revises, acotes y aceptes, así nos ponemos a trabajar en ellos.
Desde ya, muchas gracias. Saludos