Quickstart for GitHub Issues

Introduction

This guide demonstrates how to use GitHub Issues to plan and track a piece of work. In this guide, you will create a new issue and break it down into sub-issues. You'll also learn how to add labels, issue types, milestones, assignees, and projects to communicate metadata about your issue.

Prerequisites

To create an issue, you need a repository. You can use an existing repository that you have write access to, or you can create a new repository. The repository must have issues enabled. For more information about creating a repository, see Crear un repositorio nuevo. For more information about enabling issues if they are disabled in your repository, see Inhabilitar propuestas.

Opening a blank issue

First, create an issue. There are multiple ways to create an issue; you can choose the most convenient method for your workflow. This example will use the GitHub UI. For more information about other ways to create an issue, see Crear una propuesta.

1. En GitHub, navegue hasta la página principal del repositorio.

2. Debajo del nombre del repositorio, haga clic en Problemas.

   

3. Haz clic en Nueva propuesta.

4. In this example, we will start with a blank issue. Your repository may use issue templates and issue forms to encourage contributors to provide specific information. If your repository uses issue templates, click Open a blank issue.

Filling in information

Give your issue a descriptive title. The title should convey at a glance what the issue is about.

Add a description that explains the purpose of the issue, including any details that might help resolve the issue. For example, if this is a bug report, describe the steps to reproduce the bug, the expected result, and the actual result.

You can use markdown to add formatting, links, emojis, and more. For more information, see Escribir en GitHub.

Adding a task list

You can also use plain text to track tasks that don't have a corresponding issue and convert them to issues later. For more information, see About tasklists.

Assigning the issue

To communicate responsibility, you can assign the issue to a member of your organization. See Asignar propuestas y solicitudes de extracción a otros usuarios de GitHub.

Adding labels

Add a label to categorize your issue. For example, you might use a question label and a good first issue label to indicate that an issue is a question that a first-time contributor could pick up. Users can filter issues by label to find all issues that have a specific label.

You can use the default labels, or you can create a new label. For more information, see Administrar las etiquetas.

Adding issue types

You can add an issue type to classify work across the organization. See Managing issue types in an organization.

Adding the issue to a project

You can add the issue to an existing project and populate metadata for the project. For more information about projects, see Acerca de Projects.

Adding milestones

You can add a milestone to track the issue as part of a date based target. A milestone shows the progress of the issues as the target date approaches. See Acerca de los hitos.

Submitting your issue

Click Submit new issue to create your issue. You can edit any of the above fields after creating the issue. Your issue has a unique URL that you can share with team members, or reference in other issues or pull requests.

Adding sub-issues

Puede agregar subincidencias a una incidencia para dividir rápidamente porciones de trabajo más grandes en tareas. Las subincidencias agregan compatibilidad con jerarquías de incidencias en GitHub mediante la creación de relaciones entre las incidencias. Puede crear varios niveles de subincidencias que representen con precisión el proyecto si divide las tareas exactamente con el nivel de detalle que usted y el equipo necesitan. See Adición de subincidencias and Exploración de subincidencias.

Adding issue dependencies

You can define blocking relationships between issues using issue dependencies. Issue dependencies let you identify issues that are blocked by, or blocking, other work. See Creating issue dependencies.

Communicating

After your issue is created, continue the conversation by adding comments to the issue. You can @mention collaborators or teams to draw their attention to a comment. To link related issues in the same repository, you can type # followed by part of the issue title and then clicking the issue that you want to link. For more information, see Escribir en GitHub.

Next steps

You can use issues for a wide range of purposes. For example:

• Tracking ideas
• Collecting feedback
• Planning tasks
• Reporting bugs

To break your issue down into more manageable tasks, you can add multiple levels of sub-issues. See Adición de subincidencias.

Here are some helpful resources for taking your next steps with GitHub Issues:

• To learn more about issues, see About issues.
• To learn about the essentials for using GitHub's planning and tracking tools, see Planning and tracking work for your team or project.
• To learn more about how projects can help you with planning and tracking, see Más información sobre Projects.
• To learn more about using issue templates and issue forms to encourage contributors to provide specific information, see Utilizar plantillas para promover informes de problemas y solicitudes de extracción útiles.