Como ordenar el Repositorio ?

[enzzo19]

Buenas @mariaviollaz, @Martinslafer como estan ? les dejo este issue para que nos organizemos dentro del Repo y tengamos en cuenta que cosas son muy necesarias tener y como organizarlas, estamos hablando de un repo de un proyecto de Robotica, esto invlucra no solo codigo sino tambien hardware y quedan muy relacionados a proyectos de tipo maker si lo vemos asi, el problema cuando encontramos estos proyectos es que encontramos solo codigo que no sabemos sobre que Harware se ejecuta o al reves, entonces la idea es armar un repositorio con dos premisas principales:

• Si mañana desarmaramos cmpletamete el Robot, el repositorio deberia incluir todo lo necesario para poder tener una version similar a la ultima conocida del robot y no depender de recursos extras o los minimos necesarios para llegar a ese resultado !!
• Poder compartir un proyecto y hacerlo lo ms profesionalmente posible.

Para eso es que concideramos lo siguiente:

Hardware
      |---> Diagramas de conexion
      |---> Diseños de PCB (y Eletricos si fuera necesario)
      |---> Lista de Materiales
      |---> Diseño CAD (3D) 
                       |---> Archivo del robot
                       |---> Archivos .STL para imprimir con las cantidades adecuadas !!
     |---> Manual de ensamblaje y consideraciones de armado !!
Software
     |--> Python (Spyke)
                       |---> codigo principal (main.py) documentado su funcionamiento
                       |---> Test
                                 |---> Todos los test necesarios que permitan debuguear partes puntuales de funcionamiento del robot, ej. si no funcionara el 
                                         esquivar obstaculos, algo que te permita conocer los valores que toma el sensor y un movimiento basico de robot, 
                                         ejecutando esa accion, con su documentacion a cerca de como se debe realizar la prueba o montar el escenario para que 
                                         ese test sirva de debug, sea algo util y funcione
                      |--> docs 
     |---> Arduino (Nano)
                      |---> codigo principal (main.ino) documentado su funcionamiento
                       |---> Test
                                 |---> Todos los test necesarios que permitan debuguear partes puntuales de funcionamiento del robot, ej. si no funcionara el 
                                         sensor de color, algo que te permita conocer los valores que toma el sensor.
                                         con su documentacion a cerca de como se debe realizar la prueba o montar el escenario para que 
                                         ese test sirva de debug, sea algo util y funcione
                      |--> docs 
Documentacion
    |---> Competencia
                   |---> Engineering Journal
                   |---> Poster
                   |---> TDP
    |---> Robot 
                   |---> Si necesitaramos incluir documentacion relevantes a cerca de aspectos de armado, diseño, codigo, funcionamiento, consideraciones, deberiamos incluirlo en est carpeta y ordenarlo por topicos !!

Les parece si empezamosa cranear juntos ordenar el repo con esta estructura, mas cualquier otra consideracion que ustedes quieran hacer y de ahi ustedes le van dando forma ? Quizas ordenar un repo desde la web es medio cmplicado por lo que si vamos a necesitar que al menos nos juntemos media horita y los ayude a ver estos aspectos desde el VSCode que es bastante sencillo una vez que le agarran la mano :) Saludos que tengas un buen dia 👍

[enzzo19]

Si tienen tiempo peguenle una revisada a esto --> Repo Maker