Skip to content

Label Style Guide

Reparo edited this page Jul 12, 2017 · 101 revisions

Issue Label Style Guide

In order to improve organization and tracking of issues, the following labels should be used as described.

Section

Section of Punchcard that this issue belongs to.

  • user management
  • content types
  • workflows
  • permissions
  • input plugins
  • revisions
  • api
  • routing
  • database

Problem

Issues that make Punchcard feel broken or prevent us from doing further work, but otherwise work as designed. High priority.

  • blocked
  • blocker
  • bug
  • externally blocked
  • hotfix

Experience

Issues that affect a user's comprehension or overall enjoyment of Punchcard.

  • visual design
  • microcopy
  • user experience
  • developer experience
  • performance

Environment

Environment that the issue is present in, either Punchcard core or its use as a module

  • core
  • module

Mindless

Issues that are necessary but less impactful for our users.

  • cleanup
  • legal
  • technical debt
  • experience debt
  • tests
  • greenkeeper

Feedback

Issues that require further conversation to figure out how to proceed or what action steps are needed.

  • request for comments
  • help wanted
  • question
  • research
  • strategy
  • stub
  • prototype

Addition

Issues that will result in new functionality or releases.

  • feature

Improvement

Issues that will iterate on existing functionality.

  • enhancement
  • optimization

Pending

Issues where action can be taken, but has not yet.

  • under consideration
  • consumable

Inactive

Issues where no actions are needed or possible. The issue is either fixed or addressed better by other issues.

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

Epic

Epics track multiple stories together towards a desired outcome. Each epic should get a label unique to the core concept of the epic, usually 2-3 words. Epics should be labeled with their epic label and the epic label. Each story related to an epic should be labeled with that epic's label.

  • epic

Label Style Guide generated by Reparo. (Reparo on GitHub)

Home

Working on Punchcard

Org Maintenance

Architecture Planning

These architectural discussions may be out-of-date given the current state of Punchcard.

Clone this wiki locally