Github III: Wiki / Issues

Después de un tiempo, volvemos a retomar nuestros tutoriales sobre Github; en el anterior artículo, os hablamos sobre el lenguaje de marcado MarkDown. Pues bien, esta vez vamos a explicaros como crear vuestra propia wiki para vuestro proyecto en Github, usando este lenguaje de marcado(No solo para usarlo en el fichero Readme.md). Además, estudiaremos el uso del gestor de incidencias para nuestro proyecto en Github.

En primer lugar, vamos a crear nuestra página de Wiki de nuestro proyecto, para ello, vamos al apartado de wiki que encontraremos en nuestro proyecto de Github.

wiki

Una vez en esta pantalla, veremos como aparece una página inicial de nuestra Wiki o “home”. Esta página será la entrada  de nuestra wiki. Podemos editarla o crear una nueva página pulsando en el botón edit o new Page.

 

Captura de pantalla 2015-06-16 a las 13.21.29

Una vez pulsado cada uno de estos botones, entraremos en el editor; donde podremos usar markdown para poder crear nuestra página de Wiki.

Captura de pantalla 2015-06-16 a las 13.25.41

Como podemos ver en la anterior figura, tenemos una pequeña barra de herramientas con algunas opciones de edición; pero también podemos escribir nuestro texto en markdown. Una vez editada la página , escribiremos un mensaje (mensaje de commit) y pulsaremos en el botón de guardar página.

Con todo esto, ya tendríamos lista nuestra página de Wiki; podemos añadir tantas como queramos para que los usuarios de nuestro proyecto, tengan suficiente documentación.

Seguidamente, vamos a hablaros sobre el gestor de incidencias de vuestro proyecto. Este gestor, puede hacer que vuestros proyectos mejoren día a día gracias a la comunidad ya que otros usuarios que usen vuestro proyecto pueden daros información sobre errores y mejoras que pueden realizarse. Para poder entrar al gestor de incidencias solamente tenemos que pulsar en la opción “issues” que aparece en el menú de nuestro proyecto.

Captura de pantalla 2015-06-16 a las 13.16.31

Como podemos ver, hay un número de incidencias que tiene nuestro proyecto. Una vez estamos dentro, podemos ver todas las incidencias que tenemos abiertas.

Captura de pantalla 2015-06-16 a las 13.38.43

Para crear una incidencia,  solo tenemos que pulsar en el botón verde “New Issue” y pasaremos al formulario de creación de incidencias.

Captura de pantalla 2015-06-19 a las 8.36.29

 

Como podemos ver en la anterior captura, tenemos como campos el título de la incidencia y un comentario. El comentario puede realizarse usando markdown. Además tenemos los siguientes campos o características de la incidencia:

  • Label: Etiqueta que se asigna para saber que tipo de incidencia es; puede ser bug, enchancement, help wanted, question,etc.. además podemos crear nuestras propias incidencias.
  • Milestone: Cuando nuestro proyecto va creciendo, podemos ir definiendo distintas versiones o hitos para poder ir estableciendo entregas del proyecto.
  • Asignee: indica a quien esta asignada esta incidencia. Normalmente en proyectos con varios desarrolladores, se asignan las incidencias entre los integrantes del grupo.

Una vez rellenado, pulsamos en el botón submit new Issue se creará la incidencia y podremos verla en la lista de incidencias. Una vez creada, podemos ver entre otras cosas la evolución de esta ya que otros usuarios de Github pueden comentar y proponer soluciones a dicha incidencia. Para ello, en la lista de incidencias, pulsaremos en la incidencia correspondiente y podremos ver su detalle.

Captura de pantalla 2015-06-19 a las 8.45.10

 

Una vez que hemos terminado la incidencia, podemos realizar las siguientes acciones:

  • Cerrar la incidencia pulsando en el botón close issue.
  • Añadiendo la notación “#4 Fixed” en un comentario de un commit y se cerrará automáticamente. Podemos referenciar una incidencia sabiendo su número y añadiendo el carácter #.

Con este último apartado ya hemos visto como gestionar nuestras incidencias y como crear nuestra wiki para documentar nuestros proyectos. En próximos artículos sobre GitHub, hablaremos sobre la creación de Ramas y los Pull Request.

Be the first to comment on "Github III: Wiki / Issues"

Deja un comentario.

Tu dirección de correo no será publicada.


*


*