GitHub Issues are used to track ideas, enhancements, tasks, and bugs. They are a core part of project management on GitHub. This guide is your go-to resource for understanding and using Issues effectively.
✅ What Are Issues?
- Issues help teams manage bugs, feature requests, improvements, and planning tasks.
- They are interactive and can include comments, labels, assignees, milestones, and more.
✍️ How to Create an Issue
- Navigate to the Issues tab of the GitHub repository.
- Click the New issue button.
- Provide a title and optional description.
- Add labels, assignees, and optionally link it to projects or milestones.
🆚 Issue vs Discussion vs Pull Request
| Feature | Description | Has Done State? |
|---|---|---|
| Issue | A specific, actionable task (e.g., bug or feature request) | ✅ Yes |
| Discussion | Open-ended chat for brainstorming, Q&A, or community interaction | ❌ No |
| Pull Request | A proposal to merge code changes, including review and approval workflow | ✅ Yes |
🔗 Linking a Pull Request to an Issue
To automatically close an issue when a PR is merged, use one of the following keywords in the PR description:
closes #123
fixes #123
resolves #123
🚀 GitHub Collaboration Features Guide
🌿 Create a Branch from an Issue
- Visit the issue page.
- Click Create a branch in the sidebar.
- A new branch is created and auto-linked to the issue.
👥 Assign Issues
- In the Assignees section:
- Assign the issue to one or more collaborators.
- Helps clarify who is responsible.
🔍 Search and Filter Issues
Use filters in the search bar:
-
is:open,is:closed author:usernameassignee:usernamelabel:bugmentions:username
Combined example:
bash
is:open is:issue label:bug assignee:octocat
Top comments (0)