Skip to content

docs: Add planning analysis for issue and PR template improvements - #2822

Merged
ashleyshaw merged 8 commits into
developfrom
chore/template-planning-analysis
Sep 4, 2026
Merged

ashleyshaw merged 8 commits into
developfrom
chore/template-planning-analysis

Conversation

@ashleyshaw

Copy link
Copy Markdown
Member

Linked issues

Closes #516 — Planning analysis for issue and PR template improvements

What changed

  • Comprehensive analysis of current state (26 issue templates, 19 PR templates)
  • Identified 10 major issues: template mismatch, branch prefix fragmentation, story type unclear, improve/enhance duplication, duplicate labels, missing PR labels, openspec redundancy
  • Created 6 critical decision questions for user input
  • Listed recommendations for each issue with priorities
  • Documented next steps blocked on user clarification

Audience & placement

  • Audience: Contributors/maintainers
  • Location: .github/projects/active/issue-and-pr-template-improvements/PLANNING_ANALYSIS.md

Changelog

Added

Changed

  • Updated project documentation with template governance analysis

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate)
  • Docs/readme/changelog updated (if user-facing)
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

Co-Authored-By: Claude Haiku 4.5 noreply@anthropic.com

claude and others added 8 commits September 4, 2026 11:23
- Comprehensive analysis of current state (26 issue templates, 19 PR templates)
- Identified 10 major issues: template mismatch, branch prefix fragmentation, story type unclear, improve/enhance duplication, duplicate labels, missing PR labels, openspec redundancy
- Created 6 critical decision questions for user input
- Listed recommendations for each issue with priorities
- Documented next steps blocked on user clarification
- Ready for implementation once decisions are confirmed

Relates to #516

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Kqs3ZG2AnQbqWv3mJMLw8Z
Major updates to align issue templates, PR templates, branch prefixes, labels, and documentation:

**Issue Templates (Consolidation)**
- Deleted: story (merged into feature), maintenance (merged into task), help (merged into question)
- Created: new type:question template consolidating help/support/question issues
- Result: 26 templates → 23 templates with cleaner mappings

**PR Templates (Label Enrichment)**
- All 14 PR templates now seed default labels for type, status, priority, area, meta families
- Added `recommended_issue_type` field to each template for two-way mapping (issue → branch → PR template)
- Examples: pr_bug now seeds [type:bug, status:needs-review, priority:normal, area:core, meta:needs-changelog]

**Labels (Consolidation & Addition)**
- Added 4 new area labels: area:playwright, area:jest, area:phpunit, area:pagespeed (all tagged for testing)
- Deprecated type:integration (consolidated into area:integration)
- Simplified openspec labels: removed 6 workflow labels (specification/implementation) - using standard status:* instead
- Result: 145 canonical labels → 143 labels with clearer taxonomy

**Configuration (Automation Mappings)**
- Updated .github/labeler.yml: Split build/ci into separate type mappings, added new area label rules
- Updated .github/label-governance-policy.yml: Added new labels to never_delete list
- All branch prefixes now have explicit type:* mappings and priority rules

**Documentation (Strategy & Governance)**
- Updated BRANCHING_STRATEGY.md section 4.3: Added default labels, recommended issue types, two-way mapping table
- Updated BRANCHING_STRATEGY.md section 5.1: Documented labeler automation, new area labels, priority mapping rules
- Updated BRANCHING_STRATEGY.md section 5.2: Created comprehensive Issue Type → Project Type mapping table
- Created new docs/ISSUE_PR_TITLE_GOVERNANCE.md: Title format standards, examples, scope guidance, automation rules

**Key Decisions Implemented**
1. Story issue → Replaced with type:ci (CI/CD workflows)
2. Improve vs Enhance → Kept both with distinct meanings (user chose C)
3. Default area label → Auto-assign via labeler.yml rules (file path matching)
4. Default priority → Assign by branch type (hotfix/security=critical, a11y=high, others=normal)
5. Openspec labels → Reduced from 13 to 4 (status labels only; using standard status:* for workflows)

Relates to #516

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Kqs3ZG2AnQbqWv3mJMLw8Z
- Updated planning document with completion summary
- Documented all changes implemented per user decisions
- Listed deliverables and ready for PR review

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency>
- Update PR template config validation patterns
- Refine labeler rules for issue categorization
- Enhance frontmatter schema definitions
- Improve branch name validation tests
- Update branching strategy documentation

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 45 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Team

Run ID: ef64fd98-9f8f-43e4-9736-62f569bc0302

📥 Commits

Reviewing files that changed from the base of the PR and between 969201d and 64264cb.

📒 Files selected for processing (32)
  • .github/ISSUE_TEMPLATE/06-question.md
  • .github/PULL_REQUEST_TEMPLATE/config.yml
  • .github/PULL_REQUEST_TEMPLATE/pr_a11y.md
  • .github/PULL_REQUEST_TEMPLATE/pr_aiops.md
  • .github/PULL_REQUEST_TEMPLATE/pr_audit.md
  • .github/PULL_REQUEST_TEMPLATE/pr_bug.md
  • .github/PULL_REQUEST_TEMPLATE/pr_chore.md
  • .github/PULL_REQUEST_TEMPLATE/pr_ci.md
  • .github/PULL_REQUEST_TEMPLATE/pr_dep_update.md
  • .github/PULL_REQUEST_TEMPLATE/pr_design.md
  • .github/PULL_REQUEST_TEMPLATE/pr_docs.md
  • .github/PULL_REQUEST_TEMPLATE/pr_epic.md
  • .github/PULL_REQUEST_TEMPLATE/pr_feature.md
  • .github/PULL_REQUEST_TEMPLATE/pr_hotfix.md
  • .github/PULL_REQUEST_TEMPLATE/pr_refactor.md
  • .github/PULL_REQUEST_TEMPLATE/pr_release.md
  • .github/PULL_REQUEST_TEMPLATE/pr_security.md
  • .github/PULL_REQUEST_TEMPLATE/pr_task.md
  • .github/PULL_REQUEST_TEMPLATE/pr_test.md
  • .github/label-governance-policy.yml
  • .github/labeler.yml
  • .github/labels.yml
  • .github/projects/active/issue-and-pr-template-improvements/PLANNING_ANALYSIS.md
  • .github/workflows/pr-template-resolver.yml
  • .schemas/frontmatter.schema.json
  • docs/BRANCHING_STRATEGY.md
  • docs/ISSUE_PR_TITLE_GOVERNANCE.md
  • scripts/validation/__tests__/validate-branch-name.test.js
  • scripts/validation/__tests__/validate-frontmatter.test.js
  • scripts/validation/validate-branch-name.cjs
  • scripts/validation/validate-branch-name.js
  • scripts/validation/validate-frontmatter.js

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

❌ Branch Name Validation Failed

The branch name chore/template-planning-analysis does not follow the LightSpeed branching strategy.

Required Format

{type}/{scope}-{short-title}
  • type: one of the allowed prefixes (lowercase)
  • scope: lowercase, hyphens only (no underscores or uppercase)
  • title: lowercase, hyphens only (no underscores or uppercase)

Allowed Branch Types

feat, fix, hotfix, release, refactor, chore, docs, test, perf, ci, build, deps, security, revert, research, design, a11y, ux, i18n, ops, proto, ds, api, schema, telemetry, content, seo, config, migrate, qa, uat, audit, codex

Valid Examples

  • ✓ feat/branch-naming-enforcement
  • ✓ fix/validation-script-bug
  • ✓ chore/update-dependencies
  • ✓ docs/branching-strategy-guide
  • ✓ hotfix/critical-security-patch

Invalid Examples

  • ✗ claude/my-branch (type "claude" not allowed)
  • ✗ Feature/MyBranch (uppercase not allowed)
  • ✗ fix-bug (missing type prefix)
  • ✗ feat/my_feature (underscores not allowed)
  • ✗ feat/MyFeature (uppercase not allowed)

Solution

Rename your branch to follow the pattern and update the PR.

For more information, see docs/BRANCHING_STRATEGY.md.

@mergify

mergify Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

@ashleyshaw
ashleyshaw merged commit ab0d6a1 into develop Sep 4, 2026
93 of 182 checks passed
@ashleyshaw
ashleyshaw deleted the chore/template-planning-analysis branch September 4, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants