-
Notifications
You must be signed in to change notification settings - Fork 88
Issue Labels
Brenton Cheng edited this page Apr 25, 2019
·
6 revisions
A variety of labels may be attached to a given Issue. These labels are organized into a few different categories, listed below. Generally, a given Issue will only have one label from a given category. Currently, only Issue Type is required.
By convention, labels use title case, capitalizing the first letter of each word, e.g. "Design Bug".
Issue Type labels (required)
-
Bug
- A general problem with website functionality -
Design Bug
- A problem related to design, including layout or UI -
Feature Request
- A request for an entirely new feature -
Enhancement
- A request to extend/improve an existing feature -
Discussion
- A topic for community discussion
Status labels
-
Resolved: Fixed
- Used to indicate a “Bug” or “Design Bug” was fixed. -
Resolved: Closed
- Issue has been addressed. -
Resolved: Won’t Fix
- Issue is valid, but will not be fixed. Whenever possible, a comment indicating why the issue will not be fixed should be included. -
Resolved: As Intended
- Issue identified is working as intended. -
Resolved: Duplicate
- Issue is a duplicate. A comment with a link to the original issue must be included. -
Resolved: Unsolved
- Issue is valid, we want to fix it, but have been unable to do so. A comment indicating why the problem is unsolved must be included. -
Regression
- This issue was previously “Resolved: Fixed” but is happening again. When marking an issue with “Regression” you should remove the “Resolved: Fixed” label, as this issue should be considered re-opened. -
Cannot Reproduce
- Issue may or may not be valid, but it could not be reproduced. Before closing an issue as “Cannot Reproduce”, be sure the steps to reproduce the problem were clear and correctly followed. If there’s any doubt, leave the issue open and message the person who opened the issue, to see if they are still experiencing the issue and/or if they have additional reproduction steps. -
Internal
- Issue is being addressed internally within Internet Archive. This label should only be used by Internet Archive staff. -
Needs Elaboration
- Issue requires more technical or design information. Must have a comment, indicating what elaboration is required. -
Needs Design
- Issue requires UI/UX design. -
Needs QA
- Issue has potentially been addressed and needs QA or testing. -
Needs Feedback
- Issue has potentially been addressed, but the assignee would like to solicit feedback from the community. A comment indicating the kind of feedback desired must be added to the issue. -
Needs Investigation
- Solution not known / requires research.
Subject labels
-
Dev Setup
- Issue relates to setting up the development environment. -
Asset Building
- Issue related to webpack or static asset bundling/serving. -
Accessibility
- Issue relates to a lack of accessibility. -
Website Text
- Website text needs changing. -
Colors
- Visual colors need addressing. -
Layout Improvement
- Issue relates to the component's visual layout. -
Tests
- Issue relates to automated testing, e.g. unit tests or integration tests. -
Community
- Issue concerns the community (management, guidelines, etc.).
Complexity/Difficulty labels
-
Good First Issue
- Good issue for someone new to IAUX to handle Easy
Difficult
Callout labels
-
Blocked
- Let the community know that you need attention to continue progress -
Exemplary
- This issue has been handled in an exemplary way. Whenever possible, include a comment indicating why this label was added. -
Help Wanted
- This seems to be a standard GitHub label. It might either mean "more people welcome to work on this issue" or "please help me - but not blocked"
Planning labels
2019 Goals
-
October 2019 Goals
- Goals to be accomplished by/for the October anniversary event