Issues allow you to track a list of changes that need to be made to code in a repository. If there are problems that need to be fixed with a project, creating an issue is a good way of measuring progress. In addition:

  • Issues can be related to a Milestone

  • Members can be assigned to an Issue

  • Issues can be defined by Labels

  • Branches and PR's can be automatically created from Issues

    • In addition, when the PR is merged, the issue will be closed

Overall, Issues are a great Project Management tool to track changes to your code. To get started, select the Issues tab at the top of your repository page.

Creating an Issue

Because issues are associated with repositories, you need to first navigate to a repository you want to make an issue for.

Click on the Issues tab and select the New Issue button.

Provide a Title and Description for your issue. You can also Assign someone to the issue, set a Label and add it to a Milestone for tracking of multiple issues related to an overall goal.

Once you are done making edits, you can preview your issue by toggling into the Preview tab. When ready, press the Create Issue button at the bottom.

You can also drag and drop files into your issue.

You will see your issue at the top of the issue feed. Any comments or other activity related to this issue will appear chronologically.

In addition, if you wanted to create a branch and PR so that the Assignee can start work on this issue, you can use the dropdown provided. Enter the new branch name, and the Base Branch that it is being created from. The new PR will be pre-populated with the Issue number, so that there is traceability, and the Issue will close along with the closing of the PR.

Managing an Issue

Click into the Issues tab to view any issues that exist for your repository. Issues that have been resolved will appear in the Closed tab, while issues that still require attention will be organized under the Open tab.

On each Issue card, there is additional information:

  • If an issue has a comment history, a teal chat icon will appear to the right of each issue description.

  • If the Issue is assigned to someone, the user avatar will be displayed

  • Labels will be shown on the right side of the issue

  • Milestone that the issue is assigned to will be visible under the Issue name

Select an issue to reveal its detailed history. Clicking on the three dots will open a management menu that offers various conversation features. You can also use this menu to edit a previous comment that you've made.

When writing a comment, you can request feedback from other members in your organization by using the "@username" format. It might also make sense to copy the issue link to your clipboard if you want to add it to a PR or share it with a colleague externally.

It's good practice to close an issue once it's resolved. To close an issue, simply press the red Close button at the bottom of the issue feed.

Sometimes, you might want to prevent merging when an active issue exists. You can set your desired behavior for all issues within your repository on your repository's Settings page.

Closed issues will be reorganized under the Closed tab of the Issues page.

Last updated