Skip to content
BENIBIX Learn

GitHub Issues

Development🔀 Version ControlCollaboration

Also known as GitHub Issue, Issue (GitHub), Issue Tracker (GitHub)

GitHub's list of bugs, ideas and tasks, kept beside the code.

Think of it like

Think of it like a to-do board pinned beside the code. Anyone on the team can add a card or tick one off.

Example

Emma opens issue #42: the order page shows the wrong price. Jack's pull request says Closes #42, and the issue closes when it merges.

Why it matters

Work and code sit side by side, so you can see why each change was made.

Definition

GitHub Issues is the place in a GitHub repository to track bugs, ideas and tasks. Each issue gets a number, a title and a thread for talk. You can label it, assign it to a person and add it to a project board. A pull request can close an issue when it merges. You write Closes followed by the issue number in the pull request.
Issue #42 is linked to the pull request and closes when it merges.

Common mistake

Opening issues with no steps to repeat the bug. Others cannot fix what they cannot see.

Key takeaways

  1. 1
    One issue, one problem. Keep each issue to one thing.
  2. 2
    Linked to code. Pull requests can close issues.
  3. 3
    Labels and owners. Sort issues and assign them.

Learn it properly