Issues
Issues
Issues are tasks and notes that describe aspects of the project that need attention. Basically, items that make up the project’s to-do list. The issues for this project are kept in https://github.com/rbwatson/GoBabyGo/issues.
Issues should be labeled to make them easy to search. The labels used in this project are described here. Each label falls into one of three categories:
- Descriptive labels describe the type of issue and are used to organize the labels
- Process labels describe where an issue is in a process to keep track of an issue’s progress
- Outcome labels describe how an issue was closed, if it was not addressed.
- Size/Scope labels describes the relative size of the issue.
These are the labels used for issues in this project.
| Label | Category | Description |
|---|---|---|
| (closed) | Process labels | An implicit label applied to all issues that have been closed. |
| (open) | Process labels | An implicit label applied to all issues that are not closed. |
| bug | Descriptive labels | Issue describes a problem encountered with an existing document topic or feature. |
| duplicate | Outcome labels | Label that is added to an issue that is described by an earlier issue. The issue should be closed after this label is applied. |
| enhancement | Descriptive labels | Issue describes how an existing document, topic, or feature could be improved. |
| help wanted | Descriptive labels | Issue describes a problem that someone is having with which they need assistance. |
| in progress | Process labels | Label that is added to an issue that someone is working on. |
| invalid | Outcome labels | Label that is added to an issue that is not valid. The issue should be closed after this label is applied. |
| large | Size labels | Indicates a large issue that could take more than several days to complete. |
| medium | Size labels | Indicates a medium issue that could take several days to complete. |
| new topic | Descriptive labels | Issue describes a new topic or group of topics that need to be created. |
| question | Descriptive labels | Issue asks a question. |
| ready for edit | Process labels | Label that is added to a document issue that has topics ready for someone to review and edit. |
| small | Size labels | Indicates a small issue that should take a day or less to complete. |
| usability test | Descriptive labels | Issue describes a topic or topic set that is ready for usability testing. |
| wontfix | Outcome labels | Label that is added to an issue that has been reviewed and determined to not require further attention. The issue should be closed after this label is applied. |
| writing tools | Descriptive labels | Issue has to do with how the docs are written, built, edited. |
Finding and creating issues
- Issues are listed in the Issues tab in the main page of the repo.
- Filter issues by entering a label, status, or other property in the filter bar.
- Sort issues by using the column headings in the list.
- Create new issues by clicking the New issue button. Don’t forget to give your issue a label to help identify it!
- View or comment on an issue by clicking on it in the list.