Difference between revisions of "Main Page"

From Asibot & HOAP3 & TEO Wiki
Jump to: navigation, search
Line 1: Line 1:
 
__NOTITLE__
 
__NOTITLE__
 +
 +
== Buenas prácticas (IMPORTANTE! LEER PRIMERO!!) ==
 +
 +
* '''Siempre, para cualquier archivo de trabajo, por muy insignificante o borrador que parezca,''' utiliza uno de los repositorios compartidos:
 +
** Software y hardware: [https://github.com/roboticslab-uc3m GitHub (GIT, público)]. Consulta con tu tutor (que posiblemente te redirija a Juan, David o Raúl) si dudas en qué repositorio trabajar. Acomoda tu [https://git-scm.com/docs/gitignore .gitignore] al tipo de proyecto, para evitar subir ficheros que no se deberían (binarios, backups, y ficheros residuales varios).
 +
** Redacción de publicaciones: Consulta con tu tutor (que posiblemente te redirija a Juan) para la URL exacta, distribuidos a través de http://robots.uc3m.es/svn/* (SVN, privado)
 +
* '''Siempre, cuando tengas una duda, busca en esta wiki, y busca entre las issues (tanto abiertas como cerradas) del repositorio asociado a tu trabajo.''' Si no encuentras respuesta, <u>pon una issue en el repositorio asociado a tu trabajo (o comenta en la pestaña de Discussion de la wiki)</u>. Ventajas:
 +
** Incrementa la productividad global, porque queda el histórico. Se tiende a evitar el estar repetiendo las mismas preguntas y generando las mismas respuestas.
 +
** Sirve de herramienta para tratar de mantiener lo técnico dentro del contexto técnico, y a centrarse la temática forzada por el asunto de la issue.
 +
** Da mayor visibilidad a tu duda, te puede contestar gente que no te esperarías. Esto es especialmente interesante cuando hay un desacuerdo entre dos partes: pueden intervenir terceros que aporten nuevas ideas y puntos de vista.
 +
== Programación en General ==
 +
* NO utilizar números en nombres de ficheros para indicar versiones/intentos/iteraciones... ¡Para eso ya existen los hash y tag de los sistemas de control de versiones!
 +
* [http://robots.uc3m.es/dox-asibot-main/post_install.html#post_install_changing_parameters Cabeceras, ficheros de configuración y parámetros de CLI].
 +
* Lee acerca de [https://www.google.es/search?q=cleancode Clean code].
 +
== Programación C/C++ ==
 +
* Para crear un nuevo proyecto C/C++, utiliza [https://github.com/roboticslab-uc3m/project-generator project-generator].
 +
* Si hay problema con project-generator, [https://github.com/roboticslab-uc3m/project-generator/issues coméntalo en su sección de issues]. Si sigues con motivos en contra, por lo menos no dejes de utilizar [http://asrob.uc3m.es/index.php/Tutorial_CMake CMake] para cualquier proyecto C/C++.
 +
* Utiliza UpperCamelCase para nombres de librerías y de clases.
 +
* Utiliza lowerCamelCase para nombres de ejecutables.
 +
* En C++, evita el uso de variables globales.
 +
* Mantén un main() minimalista: implementa tu programa como una clase.
 +
** En C++ solemos hacer que la clase principal herede de [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html yarp::os::RFModule], con lo cual se dispone de un [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#a6c3880961b00b0a7eb527d62214169b7 configure(yarp::os::ResourceFinder& rf)] que recibe un diccionario ([http://www.yarp.it/classyarp_1_1os_1_1ResourceFinder.html rf]) pasado desde el main(), un [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#a58ce26fc6fdcb6eb4af8e8dc678e095e close()] que se llama con la señal CRTL+C, y una función [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#a37ee5baa17ce243458a1dff209e878b7 updateModule()] llamada periódicamente, con una periodicidad lenta [segundos] dada por [http://www.yarp.it/classyarp_1_1os_1_1RFModule.html#ace2fdadde1a2690f274079fabd6420d2 getPeriod()]. Si se necesita una función que se llame rápidamente, heredando de [http://www.yarp.it/classyarp_1_1os_1_1RateThread.html yarp::os::RateThread] se obtiene una función [http://www.yarp.it/classyarp_1_1os_1_1RateThread.html#ac3c97e766733b41a45c799aa0c05598f run()] que es llamada con una periodicidad [milisegundos] especificada en el constructor.
 +
* Si tienes un dispositivo, también impleméntalo como una clase, idealmente como un [http://asrob.uc3m.es/index.php/Tutorial_yarp_devices YARP device].
 +
* Crea un test para cada clase, desarrollándolo a la par de la clase. En la actualidad utilizamos '''gtest''', como en [https://github.com/roboticslab-uc3m/teo-main/tree/develop/test/testKdlSolver.cpp teo-main/test/testKdlSolver] y [https://github.com/roboticslab-uc3m/teo-body/tree/develop/test/testTechnosoftIpos.cpp teo-body/test/testTechnosoftIpos].
 +
 +
== AVISO IMPORTANTE: Al proceder, se aceptan las condiciones anteriores ==
 +
 +
Gracias!
 +
 
{| class="greentable" style="width:100%"
 
{| class="greentable" style="width:100%"
 
|-  
 
|-  

Revision as of 16:54, 13 June 2016

Buenas prácticas (IMPORTANTE! LEER PRIMERO!!)

  • Siempre, para cualquier archivo de trabajo, por muy insignificante o borrador que parezca, utiliza uno de los repositorios compartidos:
    • Software y hardware: GitHub (GIT, público). Consulta con tu tutor (que posiblemente te redirija a Juan, David o Raúl) si dudas en qué repositorio trabajar. Acomoda tu .gitignore al tipo de proyecto, para evitar subir ficheros que no se deberían (binarios, backups, y ficheros residuales varios).
    • Redacción de publicaciones: Consulta con tu tutor (que posiblemente te redirija a Juan) para la URL exacta, distribuidos a través de http://robots.uc3m.es/svn/* (SVN, privado)
  • Siempre, cuando tengas una duda, busca en esta wiki, y busca entre las issues (tanto abiertas como cerradas) del repositorio asociado a tu trabajo. Si no encuentras respuesta, pon una issue en el repositorio asociado a tu trabajo (o comenta en la pestaña de Discussion de la wiki). Ventajas:
    • Incrementa la productividad global, porque queda el histórico. Se tiende a evitar el estar repetiendo las mismas preguntas y generando las mismas respuestas.
    • Sirve de herramienta para tratar de mantiener lo técnico dentro del contexto técnico, y a centrarse la temática forzada por el asunto de la issue.
    • Da mayor visibilidad a tu duda, te puede contestar gente que no te esperarías. Esto es especialmente interesante cuando hay un desacuerdo entre dos partes: pueden intervenir terceros que aporten nuevas ideas y puntos de vista.

Programación en General

Programación C/C++

  • Para crear un nuevo proyecto C/C++, utiliza project-generator.
  • Si hay problema con project-generator, coméntalo en su sección de issues. Si sigues con motivos en contra, por lo menos no dejes de utilizar CMake para cualquier proyecto C/C++.
  • Utiliza UpperCamelCase para nombres de librerías y de clases.
  • Utiliza lowerCamelCase para nombres de ejecutables.
  • En C++, evita el uso de variables globales.
  • Mantén un main() minimalista: implementa tu programa como una clase.
  • Si tienes un dispositivo, también impleméntalo como una clase, idealmente como un YARP device.
  • Crea un test para cada clase, desarrollándolo a la par de la clase. En la actualidad utilizamos gtest, como en teo-main/test/testKdlSolver y teo-body/test/testTechnosoftIpos.

AVISO IMPORTANTE: Al proceder, se aceptan las condiciones anteriores

Gracias!

Welcome to the Asibot & HOAP3 & TEO Wiki

HAND MIX.jpg
ASIBOT

Hoap3.png
HOAP3

Teo lab 2014.jpg
TEO
AVISO IMPORTANTE
En caso de enterarte de la existencia de una DEMO, por favor ENVÍA YA email con fecha/hora y/o toda la información posible

Nuestro hilo email se llama AVISO DEMOSTRACION.

Guía general

GUÍA GENERAL DE BUENAS PRÁCTICAS

Recursos adicionales
Tutorial.jpg
Tutorials
Impresora pasillo