Issues Label Style Guide - pulibrary/pul_library_drupal GitHub Wiki

Inspired by this blog post and this implementation, we will attempt to organize our GitHub issues with consistent labels.

Section

If the repository covers multiple parts, this is how we designate where the issue lives. (e.g. Sass, JavaScript, Server, etc.).

  • all search
  • panels
  • server

Problems

Issues that make the product feel broken. High priority, especially if its present in production.

  • bug
  • security

Experience

Affect user’s comprehension, or overall enjoyment of the product. These can be both opportunities and “UX bugs”.

  • accessibility
  • content
  • responsive
  • user experience
  • visual design

Environment

Server environment. With good QA, you’ll identify issues on test and staging deployments.

Mindless

Converting measurements, reorganizing folder structure, and other necessary (but less impactful) tasks.

  • cleanup

Feedback

Requires further conversation to figure out the action steps. Most feature ideas start here.

  • question

Improvements

Iterations on existing features or infrastructure. Generally these update speed, or improve the quality of results. Adding a new “Owner” field to an existing “Calendar” model in the API, for example.

  • enhancement
  • optimization

Additions

Brand new functionality. New pages, workflows, endpoints, etc. Color: #b4e051;

  • feature
  • migration
  • models

Pending

Taking action, but need a few things to happen first. A feature that needs dependencies merged, a bug that needs further data, an issue with a possible solution, or an issue actively being worked on.

  • consumable
  • in progress

Inactive

No action needed or possible. The issue is either fixed, addressed better by other issues, or just out of product scope.

  • duplicate
  • invalid
  • on hold
  • won't fix

Epic

Impactful changes that require a great deal of planning, time, and effort.

  • epic

Current labels not included under these categories

  • dmg feature
  • drupal features