Skip to content

ISSUE_LABELS.md

Latest commit

 

History

History
130 lines (93 loc) · 7.47 KB

ISSUE_LABELS.md

File metadata and controls

130 lines (93 loc) · 7.47 KB
Raw

.github/ISSUE_LABELS.md

Checks ![Docs Validation](https://img.shields.io/badge/Docs Validation-OK-success.svg) GitLeaks ![Labeling Governance](https://img.shields.io/badge/Labeling Governance-OK-success.svg) ![Main Branch Guard](https://img.shields.io/badge/Main Branch Guard-OK-success.svg) ![Metadata Governance](https://img.shields.io/badge/Metadata Governance-OK-success.svg) Release ![Template Enforcement](https://img.shields.io/badge/Template Enforcement-OK-success.svg) ![Validate PR Template](https://img.shields.io/badge/Validate PR Template-OK-success.svg) ![Badges: Documentation Update](https://img.shields.io/badge/Badges: Documentation Update-OK-success.svg) ![Badges: Health Check](https://img.shields.io/badge/Badges: Health Check-OK-success.svg) ![Badges: README Status Maintenance](https://img.shields.io/badge/Badges: README Status Maintenance-OK-success.svg) ![Badges: Workflow Inventory Audit](https://img.shields.io/badge/Badges: Workflow Inventory Audit-OK-success.svg) branch-management changelog-management documentation events-issue-pr-metadata issue-management pr-workflow project-management release-orchestration reporting-metrics

Note: All labeling, status, type, and standardization is now handled by the unified labeling agent and labeling workflow. The canonical label definitions and automation rules are maintained in ../.github/labels.yml and ../.github/labeler.yml. This file provides human-readable guidance, while the YAML files are used for automation and syncing across the organization.

Purpose

Defines the org-wide standard for providing high‑signal, automated Issue labeling for review routing, release hygiene, and search in LightSpeed projects. Use this reference to classify Issues consistently, apply correct labels, and align with org-wide automation and reporting.

Label Families (Issues)

  • status:* — blocked, duplicate, in-progress, needs-*, on-hold, ready, wontfix.
  • priority:* — critical, important, normal, minor.
  • type:* — bug, feature, documentation, task, refactor, performance, test, security, a11y, design, improvement, release, etc.
  • area:* — content, theme, navigation, forms, ci, deployment, dependencies, analytics, woocommerce, etc.
  • comp:* — block-editor, block-json, theme-json, templates, patterns, typography, spacing, etc.
  • Context labels: env:*, compat:*, cpt:*, lang:*, plus repo‑specific phase:*, page:*, device:*, layout:*, template:*, etc.
  • Meta & release labels: meta:needs-changelog, meta:has-pr, meta:no-issue-activity, meta:no-pr-activity, meta:stale, release:patch, release:minor, release:major, release:hotfix.
  • Contributor labels: contrib:good-first-issue, contrib:help-wanted, contrib:discussion.

See ../.github/labels.yml for the up-to-date, authoritative list.

Minimum Required Labels per Issue

  • One status:* (e.g., status:needs-triage)
  • One priority:* (e.g., priority:normal)
  • One type:* (e.g., type:bug)
  • At least one area:* or comp:* (e.g., area:ci)
  • Meta/context labels as needed (e.g., meta:needs-changelog, phase:6)

These are enforced automatically by the unified labeling agent.

Color System

Labels use a consistent color palette for rapid scanning and workflow automation. Colors are assigned by family and purpose; see ../.github/labels.yml for mapping.

Automation

  • Labeling, status, type, and standardization are all handled by the unified agent and workflow (labeling.agent.js, labeling.yml).
  • Default labels are applied and enforced on all issues.
  • Label conflicts and non-canonical labels are removed or migrated automatically.

Changelog & Release Labels

  • PRs/issues affecting user-facing features must include meta:needs-changelog or a canonical changelog label.
  • Release labels (release:patch, release:minor, etc.) are required for all shipping PRs.

Sample: Issue Label Front Matter

labels:
  - status:needs-triage
  - priority:normal
  - type:bug
  - area:ci
  - meta:needs-changelog

Usage Notes

  • Keep exactly one status:* and one priority:* on every issue.
  • All labeling is automated and enforced; maintainers may adjust as needed.
  • For a full list of canonical labels and colors, see labels.yml.

The labeling agent is the single source of truth for all issue labeling, status, type, and standardization. All guidance here is directly reflected in labels.yml and enforced via automation.

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile

Maintained with ❤️ by the 🚀 LightSpeedWP Automation Team Org Profile