Skip to content

docs(#685): Wave 5.2.4 - Update Supporting Documentation #695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashleyshaw merged 2 commits into from
May 31, 2026
Merged

docs(#685): Wave 5.2.4 - Update Supporting Documentation #695

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7822fbd
docs(#685): Wave 5.2.4 - Update Supporting Documentation
claude May 31, 2026
512d656
fix(#685): Remove incorrectly-named ISSUE-FIELDS.md
claude May 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 0 additions & 196 deletions docs/ISSUE-FIELDS.md
View file
Open in desktop

This file was deleted.

34 changes: 24 additions & 10 deletions docs/ISSUE_TYPES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ description: Canonical guide for org-wide issue type definitions, assignment, an
automation. Covers all type categories, labels, and how the labeling agent assigns
types.
file_type: documentation
version: v2.1
version: v2.2
created_date: '2025-10-20'
last_updated: '2026-05-29'
last_updated: '2026-05-31'
author: LightSpeed Team
maintainer: Ash Shaw
owners:
Expand All @@ -28,6 +28,20 @@ stability: stable

---

## Latest Updates (Wave 5.2.3-5.2.4)

**Standardized Issue-Type Display Names** (2026-05-31):

- `Code Refactor` → `Refactor` (noun form, consistent with other types)
- `Build & CI` → `Build` (simplified, noun form)
- `Test Coverage` → `Testing` (noun form)
- `A11y` → `Accessibility` (full accessible name, noun form)
- `Code Review` → `Review` (simplified, noun form)
Comment on lines +35 to +39

@chatgpt-codex-connector chatgpt-codex-connector Bot May 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Align display names with canonical config

When anyone follows this guide or reruns the documentation generator, these new display names do not match the actual source of truth: in this same commit, .github/issue-types.yml and .github/issue-fields.yml still list Code Refactor, Build & CI, Test Coverage, A11y, and Code Review, and scripts/consolidate-issue-types.js still emits the old names. Because the note above says issue-types.yml is the canonical mapping used by automation, the docs now instruct users to look for Type values the automation/config does not provide; update the canonical config and generator as part of this change, or keep the docs aligned with the existing names.

Useful? React with 👍 / 👎.


**Rationale**: Display names now use consistent noun forms while label names (e.g., `type:a11y`, `type:test`) remain unchanged. This follows the pattern of other type mappings where display name differs slightly from label suffix (e.g., `Testing` → `type:test`, `Accessibility` → `type:a11y`).

---

## Purpose

Defines the org-wide standard for **Issue Types** in LightSpeed projects.
Expand All @@ -45,11 +59,11 @@ This guide is for choosing a type, understanding type automation, and aligning w
- **Story** — User-centred vertical slice within an Epic. *Label:* `type:story`
- **Improvement** — Enhance existing behaviour or UX. *Label:* `type:improve`
- **Refactor** — Internal restructure for maintainability, no behaviour change. *Label:* `type:refactor`
- **Build & CI** — Tooling, pipelines, packaging, releases, deploys. *Label:* `type:build`
- **Build** — Tooling, pipelines, packaging, releases, deploys. *Label:* `type:build`
- **Automation** — Bots/actions/scripts that reduce toil. *Label:* `type:automation`
- **Test Coverage** — Add or expand tests (unit, integration, E2E). *Label:* `type:test`
- **Testing** — Add or expand tests (unit, integration, E2E). *Label:* `type:test`
- **Performance** — Improve speed/efficiency. *Label:* `type:performance`
- **A11y** — Accessibility to WCAG 2.1 AA. *Label:* `type:a11y`
- **Accessibility** — Accessibility to WCAG 2.1 AA. *Label:* `type:a11y`
- **Security** — Security issues or improvements. *Label:* `type:security`
- **Compatibility** — Browser/device/plugin compatibility. *Label:* `type:compatibility`
- **Integration** — Integration with external systems/services. *Label:* `type:integration`
Expand All @@ -59,7 +73,7 @@ This guide is for choosing a type, understanding type automation, and aligning w
- **Research** — Discovery, investigation, or technical spikes. *Label:* `type:research`
- **Chore** — Small hygiene change (typo, config, rename). *Label:* `type:chore`
- **Audit** — Security, code, or process audits. *Label:* `type:audit`
- **Code Review** — Peer review, QA, or validation. *Label:* `type:review`
- **Review** — Peer review, QA, or validation. *Label:* `type:review`
- **AI Ops** — AI/automation operations, agents, or datasets. *Label:* `type:ai-ops`
- **Content Modelling** — Content structure, CPTs, or taxonomy. *Label:* `type:content-modelling`
- **Question** — Clarification request or open question. *Label:* `type:question`
Expand All @@ -81,11 +95,11 @@ See [../.github/issue-types.yml](../.github/issue-types.yml) for the machine-rea
| 📖 **Story** | `type:story` | Blue `#4393f8` | User-centred vertical slice | normal/important | `comp:*`, `env:staging`, `meta:has-pr` |
| 🔧 **Improvement** | `type:improve` | Grey `#9198a1` | Enhance existing behaviour | normal/minor | `comp:*`, `area:*`, `meta:has-pr` |
| ♻️ **Refactor** | `type:refactor` | Grey `#9198a1` | Internal restructure (no UX change) | normal/minor | `lang:*`, `meta:no-changelog` |
| ⚙️ **Build & CI** | `type:build` | Blue `#4393f8` | Tooling/pipelines/releases | normal/important | `area:ci`, `lang:js\|yaml`, `env:*` |
| ⚙️ **Build** | `type:build` | Blue `#4393f8` | Tooling/pipelines/releases | normal/important | `area:ci`, `lang:js\|yaml`, `env:*` |
| 🤖 **Automation** | `type:automation` | Blue `#4393f8` | Bots/actions/scripts | normal | `area:ci`, `meta:has-pr` |
| 🧪 **Test Coverage** | `type:test` | Yellow `#d29922` | Add/expand tests | normal/important | `area:tests`, `lang:*`, `env:staging` |
| 🧪 **Testing** | `type:test` | Yellow `#d29922` | Add/expand tests | normal/important | `area:tests`, `lang:*`, `env:staging` |
| ⚡ **Performance** | `type:performance` | Yellow `#d29922` | Improve speed/efficiency | important/critical | `comp:*`, `env:*`, `meta:has-pr` |
| ♿ **A11y** | `type:a11y` | Pink `#db61a2` | Accessibility (WCAG 2.1 AA) | critical/important | `comp:*`, `env:*`, `meta:has-pr` |
| ♿ **Accessibility** | `type:a11y` | Pink `#db61a2` | Accessibility (WCAG 2.1 AA) | critical/important | `comp:*`, `env:*`, `meta:has-pr` |
| 🔒 **Security** | `type:security` | Red `#9f3734` | Security issues/improvements | critical | `priority:critical`, `env:*`, `compat:*` |
| 🔌 **Compatibility** | `type:compatibility` | Orange `#8d4821` | Browser/device/plugin compat | important/critical | `compat:*`, `env:*`, `meta:has-pr` |
| 🔄 **Integration** | `type:integration` | Orange `#8d4821` | External systems/services | important/normal | `area:integration`, `lang:*`, `env:*` |
Expand All @@ -95,7 +109,7 @@ See [../.github/issue-types.yml](../.github/issue-types.yml) for the machine-rea
| 🔬 **Research** | `type:research` | Grey `#9198a1` | Discovery/investigation/spikes | normal/important | `area:*`, `env:prototype` |
| 🧹 **Chore** | `type:chore` | Grey `#9198a1` | Small hygiene change | minor | `priority:minor`, `meta:no-changelog` |
| 🧪 **Audit** | `type:audit` | Grey `#9198a1` | Security/code/process audits | important/normal | `type:security\|a11y\|performance` |
| ✅ **Code Review** | `type:review` | Blue `#4393f8` | Peer review/QA/validation | normal | `status:needs-review`, `meta:has-pr` |
| ✅ **Review** | `type:review` | Blue `#4393f8` | Peer review/QA/validation | normal | `status:needs-review`, `meta:has-pr` |
| 🤖 **AI Ops** | `type:ai-ops` | Blue `#4393f8` | AI agents/prompts/datasets | normal | `ai-ops:*`, `lang:md\|json\|yaml` |
| 🗂️ **Content Modelling** | `type:content-modelling` | Purple `#ab7df8` | CPT/taxonomies/field mapping | important | `cpt:*`, `comp:*`, `env:staging` |
| ❓ **Question** | `type:question` | Purple `#5319e7` | Clarification request/open question | normal | `status:needs-more-info`, `area:*` |
Expand Down
Loading