glueckpress/Comprehensive-GitHub-Labels.md

## Comprehensive-GitHub-Labels.md

      
    Raw
  

              Comprehensive-GitHub-Labels.md
            
          
    Comprehensive GitHub Labels

A style guide for using GitHub issue tracker labels effectively for basic project management in the context of collaboration on open source web software (e.g. a WordPress plugin).
Colors and Notation


Color/Notation
Purpose


red
problems


yellow
holdups


green
enhancements


blue
progress


purple
discussion


lowercase
general states and types (bug, enhancement, needs dev feedback, in progress,…)


Capitalized
specific categories or epics (Copy, I18n, L10n Language Packs, WP API Compat,…)


Issue Types


Name
Purpose


bug
Acknowledged as bug to be fixed.


enhancement
Describes future enhancements to be discussed and implemented.


duplicate
Duplicate of another (earlier or better covered) existing issue.


I18n
Related to the technical aspects of making strings in code translatable (internationalization).


L10n
Related to the translation of strings (localization).


Default Copy
Related to default language strings.


UI
Epic: All things technical regarding user interface.


Language Packs
Epic: All things w.org language packs.


*
Additional labels can be used to indicate specific functionality-related issues or epics.


Issue States


Name
Purpose


feedback wanted
General discussion.


needs code review
Requires code review in order to proceed.


needs dev feedback
Requires developer/technical feedback in order to proceed.


needs reporter feedback
Requires feedback from the person who reported the issue in order to proceed.


needs test
Requires testing in order to proceed.


needs documentation
Requires testing in order to proceed.


in progress
Issue/PR is actively being worked on.


blocked
Depends on other issues to be closed or code to be merged elsewhere.


ready for merge
Pull request has been reviewed and can be merged, but may be blocked, so won’t be merged right away.


wontfix
Rejected issue not to be revisited in the future.


❤️ Mad props @Rarst for sharing his ideas on GitHub labels for better workflows.
Color/Notation	Purpose
red	problems
yellow	holdups
green	enhancements
blue	progress
purple	discussion
lowercase	general states and types (`bug`, `enhancement`, `needs dev feedback`, `in progress`,…)
Capitalized	specific categories or epics (`Copy`, `I18n`, `L10n` `Language Packs`, `WP API Compat`,…)
Name	Purpose
`bug`	Acknowledged as bug to be fixed.
`enhancement`	Describes future enhancements to be discussed and implemented.
`duplicate`	Duplicate of another (earlier or better covered) existing issue.
`I18n`	Related to the technical aspects of making strings in code translatable (internationalization).
`L10n`	Related to the translation of strings (localization).
`Default Copy`	Related to default language strings.
`UI`	Epic: All things technical regarding user interface.
`Language Packs`	Epic: All things w.org language packs.
*	Additional labels can be used to indicate specific functionality-related issues or epics.
Name	Purpose
`feedback wanted`	General discussion.
`needs code review`	Requires code review in order to proceed.
`needs dev feedback`	Requires developer/technical feedback in order to proceed.
`needs reporter feedback`	Requires feedback from the person who reported the issue in order to proceed.
`needs test`	Requires testing in order to proceed.
`needs documentation`	Requires testing in order to proceed.
`in progress`	Issue/PR is actively being worked on.
`blocked`	Depends on other issues to be closed or code to be merged elsewhere.
`ready for merge`	Pull request has been reviewed and can be merged, but may be blocked, so won’t be merged right away.
`wontfix`	Rejected issue not to be revisited in the future.