Issues track work and problems
GitHub Issues provide a shared place to record bugs, feature requests, tasks and questions. A useful issue contains enough context for another person to understand the problem without a private conversation.
Good issue structure
For a bug, include expected behavior, actual behavior, reproduction steps and relevant environment information. For a feature, describe the problem, desired outcome and acceptance criteria.
Link work to issues
Pull requests and commits can reference issue numbers. This creates a traceable path from a reported problem to the implementation that addresses it.
ADVERTISEMENT