ISSUE
Un issue es una herramienta designada para hacer mejoras a un sistema, este puede ser un arreglo de fallos, una característica pedida, una tarea, una solicitud de documentación en específico y todo tipo de solicitud al equipo de desarrollo.
Los issues también sirven para asignarle tareas de un proyecto a algún colaborador en específico. Otra utilidad de los issues es que se les puede poner etiquetas lo cual facilita mas las búsquedas.
CREACIÓN DE UN ISSUE
Los issues pueden ser creados por cualquier usuario que tenga acceso de extracción a un repositorio de esta manera:
POST/repos/: owner/: repo/issues
a continuación se muestran los parámetros que puede recibir un issue:
| Nombre | Tipo | Descripción |
| title | string | Necesario. El título del issue. |
| body | string | El contenido del issue. |
| assignee | string | Accede por el usuario que esta issue debe ser asignada.
NOTA: Solo usuarios con push access pueden establecer asignación para nuevas issue. De lo contrario el asignado es suprimido.
|
| milestone | number | Milestone (categorías) para asociar la issue (tema).
NOTA: Solo usuarios con push access pueden establecer categorías para nuevas issue. De lo contrario la categoría es suprimida.
|
| labels | array ofstrings | Etiquetas para asociar con la issue (tema)
NOTA: Solo usuarios con push access pueden establecer etiquetas para nuevas issue. De lo contrario la etiqueta sera suprimida.
|
| creator | string | El usuario que creó el issue. |
| mentioned | string | Un usuario que se mencionó en la edición. |
| sort | string | Lo que hay que ordenar. Pueden ser created, updated, comments. Default: created. |
| direction | string | La dirección de la ordenación. Puede ser: asc o desc. Default: desc |
| since | string | Sólo se devuelven los temas actualizado en o después de esta hora. Esta es una marca de tiempo en la norma ISO 860. Formato: YYYY-MM-DDTHH:MM:SSZ. |
EJEMPLO:
{
</code>”title”<b>:</b><code></code>”<Titulo de el issue>”,
</code>”body”<b>:</b><code></code>”<Cuerpo o descripción del issue>.”,
</code>”assignee”<b>:</b><code></code>”<Nombre del colaborador al cual se le asigna este issue>”,
</code>”milestone”<b>:</b><code></code>1,
</code>”labels”<b>:</b><code></code>[
</code>”<Etiqueta>”,
</code>”<Etiqueta>”
</code>]
}
CERRAR ISSUES
Los issues pueden ser cerrados a través de un commit, y se hace de la siguiente forma:
Al entrar en “Fixes #45” en un mensaje de consignación, la edición # 45 se cierra una vez que el commit se combina en su rama por defecto. Si el error no se corrige en su rama por defecto, la issue sigue abierta. Una vez que el commit con el fix se combina en su rama por defecto, el tema se cierra automáticamente.
otros comandos aceptados que se pueden usar con el commit para cerrar un issue son:
- close
- closes
- closed
- fix
- fixes
- fixed
- resolve
- resolves
- resolved
