Example Issue #18
Description
This issue will serve as an example issue for the demonstration.
Issues are suggested improvements, tasks or questions related to the repository. Issues can be created by anyone (for public repositories), and are moderated by repository collaborators. Each issue contains its own discussion thread. You can also categorize an issue with labels and assign it to someone.
From the GitHub Guides Mastering Issues, a typical issue looks like:
- A title and description describe what the issue is all about.
- Color-coded labels help you categorize and filter your issues (just like labels in email).
- A milestone acts like a container for issues. This is useful for associating issues with specific features or project phases (e.g. Weekly Sprint 9/5-9/16 or Shipping 1.0).
- One assignee is responsible for working on the issue at any given time.
- Comments allow anyone with access to the repository to provide feedback.
Issues can include checklists:
- Fix bug
- Add feature
- Write documentation
When reporting bugs or errors for software projects, it is often helpful to include a helpful snippet of code:
print("Hello world!")
Hello world!
You can also assign your issues to Projects and visualise them on your project kanban board.