What is an Issue ?
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
They're kind of like email—except they can be shared and discussed with the rest of your team.
Most software projects have a bug tracker of some kind. GitHub's tracker is called Issues, and has its own section in every repository.
Assigning an issue to a project will add a card in To do of the project for easier tracking.
You can open an issue for the following reasons:
- You found a bug
- You want to propose new feature
- You want to propose enhancement to an existing feature
- You found incorrect information in documentations
You can close an Issue for the following reason:
- You completed or fixed the request/issue
- The issue is not caused by the project
- The team decided to not add a feature request
To properly close a bug issue that has been fixed:
You must add the issue number in the comment of the commit fixing the issue.
Commit Title: Fixed bug related to unresponsive menu
Commit Description: Fixed issue #30
