Trucos para manejar issues en GitHub

ejemplo de github-issues
Bootstrap’s Issues section

Los buenos commits están bien documentados y permiten entender desde un vistazo la cronología del proyecto y facilitar así la búsqueda. Por esto GitHub nos permite dentro del mensaje de un commit tratar issues ¿Sabias que puedes cerrar un issue en un commit? además puedes mencionar usuarios e incluso otros commits.

Para mencionar o referenciar un usuario dentro de un commit basta con tipear @username (en username se usa el usuario que queramos mencionar)

Ejemplo:

@jhon colaboró en esta parte.

Para mencionar un issue se utiliza un hashtag seguido de un id: #issue_id

Ejemplo:

intentando resolver el problema #33.

Incluso se puede cerrar un issue o varios en un commit usando keywords:
close closes closed fix fixes fixed resolve resolves resolved
es recomendable escribir mensajes de los commits en inglés para ser congruente con los keywords.
Así que por ejemplo si el commit no resuelve el problema pero se decide cerrar el commit se entiende usar los keyword ‘close, closes o closed’, si el issue es un bug y el commit resuelve el error seria mejor usar los keywords ‘fix, fixes o fixed’ y si fuera una mejora requerida se puede usar ‘resolve, resolves o resolved’. todos los keywords igualmente cierran el issue referenciado.

En caso de ser un issue a cerrar:

This Closes #123

Si el caso es de cerrar un issue de otro repositorio debemos usar la sintaxis de username/repository#issue_id, ejemplo:

This Closes example_user/example_repo#76

Además podemos cerrar múltiples issues en un solo commit (tal vez no sea tan bueno siempre)

This closes #34, closes #23, and closes example_user/example_repo#42

Finalmente se puede referenciar o mencionar otro commit usando el md5 hash
Ejemplo:

e87947412f9b80d1c89e71541f8322a822301245 también funciona y se parece a este.

BONUS:

¿Que tal y le agregamos emoción al commit?, también podemos usar emojis en el mensaje del commit usando la sintaxis :emoji:
para ver todos los emojis disponibles puede ir a Emoji cheat sheet.

Hay muchas cosas que podemos hacer con git y github pero relacionar usando los commits me ha ayudado mucho. Espero que también les sea útil.

Actualización:

Todo esto también aplica si utilizas Gitlab, puedes ir a la documentación de gitlab y aprender más trucos.

Mostrar comentariosCerrar comentarios

Deja un comentario