Chuleta de GitHub Guía indispensable para uso de github

Cristian Romero Matesanz - https://github.com/cristianprofile

CHULETA GITHUB - CRISTIAN ROMERO MATESANZ �1

Funcionalidades generales de GithubFuncionalidades Github importantes

Funcionalidad Descripción Url mas información

Issues Permite administrar las issues de un proyecto, pudiendo asignar diferentes labels, responsables, milestone asociada

https://github.com/blog/831-issues-2-0-the-next-generation

pull request Mecanismo de control de código usado para la fusion de ramas. Es sencillo y muy potente, nos permite realizar comentarios sobre el código subido y sobre la rama en cuestión. Podemos asignar diferentes labels, responsables, milestone asociada

https://help.github.com/articles/using-pull-requests/

https://help.github.com/articles/commenting-on-the-diff-of-a-pull-request/

label Etiquetas usadas para categorizar tanto issues como pull request. Tenemos unas predefinidas y podemos crear nuevas. Ej: bug, feature etc…

https://help.github.com/articles/creating-and-editing-labels-for-issues-and-pull-requests/

milestone Una milestone es una agrupación lógica de issues y pull request. Se puede ver como un sprint de Scrum. De modo que tendremos controlado que issues y pull request son resueltas para cada versión de nuestro producto

https://guides.github.com/features/issues/

CHULETA GITHUB - CRISTIAN ROMERO MATESANZ �2

relaciones issues e informar a usuarios

Para poder reverenciar a un usuario dentro de nuestra issue o pull request usaremos @username. Si queremos hacer referencia a otra issue: #5 (id de la issue)

https://guides.github.com/features/issues/

close issue via commit Desde cualquier commit podemos cerrar una issue usando palabras reservadas en el comentario del commit. Ej “close #3”. La issue será cerrada cuando dicho commit sea “mergeado” a nuestra rama principal, normalmente sera master.

https://help.github.com/articles/closing-issues-via-commit-messages/

close issue via pull request

Desde una pull request podemos cerrar 1 o n issues escribiendo en el cuerpo de la pull request una referencia a la incidencia en si tal y como realizamos con los commit pero en el body de nuestra pull request. Ej: esta pull request close #3. Nota: solo serán cerradas cuando la pull request sea desde cualquier rama a la rama principal.

https://github.com/blog/1506-closing-issues-via-pull-requests

Funcionalidad Descripción Url mas información

CHULETA GITHUB - CRISTIAN ROMERO MATESANZ �3

Crear site y wiki del proyecto

Github nos permite crear un site de manera automática en nuestro proyecto. Nos alojara la página como una rama nueva denominada gh-pages. Tambien una wiki.

https://pages.github.com

https://help.github.com/articles/about-github-wikis/

Administrar release y versiones beta

Github analiza nuestro tags para saber las versiones de nuestro producto. Nos permite dar descripción a cada una de ellas y añadir ficheros que necesitemos adicionales para usar nuestro proyectos. Podemos etiquetarlas como versiones beta o bien como versiones release

https://help.github.com/articles/creating-releases/

Funcionalidad Descripción Url mas información

CHULETA GITHUB - CRISTIAN ROMERO MATESANZ �4

Uso de wafle

Wafle nos permite administrar nuestras issues y pull request alojadas en Github para ser administradas mediante un tablón funcional y flexible que nos permite control total y automatizar el etiquetado de issues automático dependiendo del estado de nuestra issue.

Ademas nos permite dar un peso de duración a cada una de nuestras issues para así poder conocer exactamente el tiempo estimado así como gráficos interesantes para ver como vamos en cada milestone asociada: Throughput y Milestone Burnup

https://waffle.io/waffleio/waffle.io

CHULETA GITHUB - CRISTIAN ROMERO MATESANZ �5

CHULETA GITHUB - CRISTIAN ROMERO MATESANZ �6