Labels and Other Information - psu-libraries/library_data_services GitHub Wiki

Labels provide an important means for organizing and managing GitHub issues. The provide additional metadata about the issue, make it possible to group issues into categories, facilitate searching for issues and also they can automatically populate Waffle.io columns that are associated with the issue.

There are a few best practices to consider when labeling and creating columns on a Waffle board.

• Look for existing labels first and use those.
• Label names should be ...
  • Brief.
  • Descriptive.
  • Lower case.
• Try to make the color the same as other related labels.
• Try not to use the same color as unrelated labels.
• Only create Waffle board columns if absolutely necessary.

Some Current Labels and Columns

This list isn't complete. It just captures some of the the more important labels in use. You can go to the Label page in Github to see all the labels that have been created, although many of them are automatically created by Github.

Label	Waffle Column	Description
problem	yes	A description of a problem
solution	yes	A description of a solution to a problem
assessment	no	Service assessment issue
partner	yes	Potential or current service partner
ready	yes	A service or activity that is ready to start
in progress	yes	A service or activity that is currently in development
ice box	yes	A service or activity that won't be worked on in the foreseeable future
question	no	A question not related to a specific issue ( those go in issue comments )