Skip to content

design: Linting Agent Specification — Phase 1 (OpenSpec) - #1817

Merged
ashleyshaw merged 7 commits into
developfrom
design/linting-agent-specification
Aug 12, 2026
Merged

design: Linting Agent Specification — Phase 1 (OpenSpec)#1817
ashleyshaw merged 7 commits into
developfrom
design/linting-agent-specification

Conversation

@ashleyshaw

@ashleyshaw ashleyshaw commented Aug 12, 2026

Copy link
Copy Markdown
Member

Linked issues

Closes #1818, #1819, #1821, #1822

Changelog

Added

  • SPECIFICATION.md (471 lines) — Complete linting agent specification with 5 Mermaid diagrams
  • TEST_PLAN.md (506 lines) — Detailed test strategy with 75+ test cases and 95%+ coverage target
  • AGENT_PROMPT_DRAFT.md (314 lines) — Full agent prompt ready for Phase 2 implementation
  • IMPLEMENTATION_PLAN.md (317 lines) — Phase 2 detailed roadmap with 4 Mermaid diagrams
  • Updated README.md with 4-phase timeline and project status

Changed

  • Project README reflects Phase 1 completion and Phase 2 readiness
  • Enhanced project structure with comprehensive planning documentation

Checklist (Global DoD / PR)


OpenSpec Phase 1 Complete + Phase 2 Planning Ready

Comprehensive specification and planning for portable, organisation-wide linting agent with single portable agent architecture, auto-discovery of canonical linting configs, support for 8+ file types, WordPress compatibility, 75+ test cases with ≥95% coverage target, and detailed Phase 2 roadmap (10-16 hours).

🤖 Generated with Claude Code

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@ashleyshaw, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 13 minutes

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

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 1b3a9b45-1731-4d3a-9498-ad0c3e9d97af

📥 Commits

Reviewing files that changed from the base of the PR and between 664fa91 and dad5ce3.

📒 Files selected for processing (5)
  • .github/projects/active/linting-agent-2026-08-12/AGENT_PROMPT_DRAFT.md
  • .github/projects/active/linting-agent-2026-08-12/IMPLEMENTATION_PLAN.md
  • .github/projects/active/linting-agent-2026-08-12/README.md
  • .github/projects/active/linting-agent-2026-08-12/SPECIFICATION.md
  • .github/projects/active/linting-agent-2026-08-12/TEST_PLAN.md

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.

@ashleyshaw

Copy link
Copy Markdown
Member Author

Related Issues

This PR is linked to the following GitHub issues for tracking implementation progress:

Epic Issue

Phase-Specific Issues

Status: Phase 1 specification complete in this PR. Implementation (Phase 2-4) pending.

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

📄 README Validation

✅ All README checks passed.

Check Result
✅ Frontmatter Passed
✅ Structure Passed

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

🎨 Mermaid Diagram Validation

❌ One or more Mermaid diagram checks failed.

Check Result
✅ Syntax Passed
✅ Accessibility Passed
❌ Colour Contrast Failed

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

✅ Template check passed after update. Thanks for fixing the PR description.

@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 40
Projects with Links: 34

❌ Missing Related Issues Section

The following projects are missing a "Related Issues" section in their README.md:

  • linting-agent-2026-08-12
  • release-agentic-workflows-2026-08-11

See Linking Standard for format.


Validation Date: 2026-08-12T10:00:49.124Z
Validator: GitHub Actions

@github-actions github-actions Bot added status:needs-review Awaiting code review type:design Design work area:dependencies Composer/npm dependency work lang:js JavaScript/TypeScript lang:json JSON config/content priority:normal Default priority type:chore Chore / small hygiene change type:ci CI/CD pipeline work meta:needs-changelog Requires a changelog entry before merge labels Aug 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

❌ Branch Name Validation Failed

The branch name design/linting-agent-specification 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.

ashleyshaw added a commit that referenced this pull request Aug 12, 2026
- Epic issue: #1818 (Linting Agent Design & Implementation)
- Phase 2: #1819 (Implementation)
- Phase 3: #1821 (Testing & Coverage)
- Phase 4: #1822 (Documentation & Deployment)

Also linked issues in PR #1817 comment.
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

🔍 Reviewer Summary for PR #1817

CI Status:success
Files changed: 5
Risk Distribution: 0 critical, 5 high, 0 medium, 0 low

Recommendations

  • Ready to proceed pending human review

@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

⏱️ Aging and SLA annotation

  • Age: 0 day(s)
  • SLA state: Within SLA
  • Thresholds: warn at 7 days, breach at 14 days
  • Last updated: 2026-08-12T11:01:02.024Z

Maintained by project-meta-sync workflow.

@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 40
Projects with Links: 34

❌ Missing Related Issues Section

The following projects are missing a "Related Issues" section in their README.md:

  • linting-agent-2026-08-12
  • release-agentic-workflows-2026-08-11

See Linking Standard for format.


Validation Date: 2026-08-12T10:04:40.472Z
Validator: GitHub Actions

@github-actions github-actions Bot removed type:chore Chore / small hygiene change type:ci CI/CD pipeline work labels Aug 12, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 40
Projects with Links: 35

❌ Missing Related Issues Section

The following projects are missing a "Related Issues" section in their README.md:

  • release-agentic-workflows-2026-08-11

See Linking Standard for format.


Validation Date: 2026-08-12T10:10:58.036Z
Validator: GitHub Actions

@ashleyshaw
ashleyshaw enabled auto-merge (squash) August 12, 2026 10:11
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 40
Projects with Links: 35

❌ Missing Related Issues Section

The following projects are missing a "Related Issues" section in their README.md:

  • release-agentic-workflows-2026-08-11

See Linking Standard for format.


Validation Date: 2026-08-12T10:12:39.874Z
Validator: GitHub Actions

@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 40
Projects with Links: 35

❌ Missing Related Issues Section

The following projects are missing a "Related Issues" section in their README.md:

  • release-agentic-workflows-2026-08-11

See Linking Standard for format.


Validation Date: 2026-08-12T10:13:58.558Z
Validator: GitHub Actions

@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 40
Projects with Links: 35

❌ Missing Related Issues Section

The following projects are missing a "Related Issues" section in their README.md:

  • release-agentic-workflows-2026-08-11

See Linking Standard for format.


Validation Date: 2026-08-12T10:17:41.605Z
Validator: GitHub Actions

@ashleyshaw
ashleyshaw force-pushed the design/linting-agent-specification branch from df2d425 to 17d4ca0 Compare August 12, 2026 10:56
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 42
Projects with Links: 39

✅ All projects have Related Issues sections

Detailed issue link validation is deferred to Phase 4.


Validation Date: 2026-08-12T10:56:41.020Z
Validator: GitHub Actions

ashleyshaw and others added 7 commits August 12, 2026 12:57
…lete)

OpenSpec Phase 1 deliverables for portable, organisation-wide linting agent.

**Specification & Planning:**
- SPECIFICATION.md: Architecture, requirements, design decisions, test strategy
- README.md: 4-phase project timeline with deliverables
- TEST_PLAN.md: 75+ test cases, 95%+ coverage target, E2E for 3 repo types
- AGENT_PROMPT_DRAFT.md: Full agent prompt with standards integration

**Design Highlights:**
- Single portable agent (no repo-type-specific variants)
- Auto-discovers canonical configs (ESLint, PHPCS, yamllint, etc.)
- Supports 8+ file types and Windows/Unix paths
- WordPress-compatible (plugins, themes, classic)
- Normalises findings across linter formats
- Generates actionable Markdown reports

**Next Steps (Phases 2-4):**
- Phase 2: Implement + enhance linting.agent.js
- Phase 3: 75+ tests with ≥95% coverage
- Phase 4: Documentation + deployment

Related GitHub issues TBD.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
- Epic issue: #1818 (Linting Agent Design & Implementation)
- Phase 2: #1819 (Implementation)
- Phase 3: #1821 (Testing & Coverage)
- Phase 4: #1822 (Documentation & Deployment)

Also linked issues in PR #1817 comment.
- Add Related Issues section to project README.md (fixes project linking validation)
- Update Mermaid diagrams with explicit WCAG color contrast styling
- Update PR description with proper template (linked issues, changelog, DoD checklist)

Addresses feedback from:
- Project Linking Validation (missing Related Issues)
- Mermaid Diagram Validation (color contrast)
- PR Template Enforcement (required sections)
- Remove theme initialization configs that may cause validation issues
- Use simple quote syntax for node labels
- Keep diagram structure and readability intact
- Should resolve Mermaid diagram validation failures
- Update column headers: 'Phase' → 'Purpose'
- Add status badges (🟡 In Progress, ⏰ Planned)
- Match LINKING_STANDARD.md format exactly
- Resolves project linking validation failure
- Update ./instructions/ paths to ../../../instructions/ (correct relative paths from project folder)
- Update ./CLAUDE.md to ../../../CLAUDE.md
- Fix all 9 broken links in Standards and References sections
- Resolves lint-and-links validation failure
- Add IMPLEMENTATION_PLAN.md: 317 lines with 4 Mermaid diagrams
- Detail all Phase 2 components (agent prompt, JS enhancement, config guide)
- Provide 10-16 hour timeline with 6-step workflow
- Include success criteria and risk mitigation
- Update README.md to reflect Phase 1 completion
- Ready for Phase 2 implementation execution

OpenSpec Deliverables:
✅ Phase 1: 1,600+ lines of specification, 5+ diagrams
✅ Phase 2: 317 lines of implementation plan, 4 diagrams
✅ Total: 1,900+ lines, detailed roadmap for Phases 2-4

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
@ashleyshaw
ashleyshaw force-pushed the design/linting-agent-specification branch from 17d4ca0 to dad5ce3 Compare August 12, 2026 10:58
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Project Linking Validation

Projects Checked: 42
Projects with Links: 39

✅ All projects have Related Issues sections

Detailed issue link validation is deferred to Phase 4.


Validation Date: 2026-08-12T10:59:42.922Z
Validator: GitHub Actions

@ashleyshaw
ashleyshaw merged commit 3e74884 into develop Aug 12, 2026
37 of 46 checks passed
@ashleyshaw
ashleyshaw deleted the design/linting-agent-specification branch August 12, 2026 11:01
ashleyshaw added a commit that referenced this pull request Aug 12, 2026
* docs: Planning Phase Complete — Issue Management Agent Ready for Phase 2

PLANNING PHASE SUMMARY (Aug 12-19, 2026)
═══════════════════════════════════════════════════════════════════

✅ DELIVERABLES
───────────────────────────────────────────────────────────────────
1. README.md (~500 lines)
   └─ Project overview, navigation guide, success criteria

2. QUESTIONS_AND_ANSWERS.md (~3,000 lines)
   └─ 5 strategic questions answered with best practice rationale
   └─ 4 embedded Mermaid diagrams
   └─ Configuration examples and Phase 5 roadmap

3. INTEGRATION_WITH_EXISTING_AGENTS.md (~400 lines)
   └─ Issues Agent v2.1 coordination
   └─ Labeling Agent v2.2 integration
   └─ No-conflict label boundaries

4. AGENT_ECOSYSTEM_ARCHITECTURE.md (~550 lines)
   └─ Multi-agent ecosystem design (3 agents, 0 conflicts)
   └─ Label ownership matrix
   └─ Integration patterns with Mermaid diagrams

5. PLANNING_PHASE_COMPLETE.md (this file)
   └─ Comprehensive planning summary
   └─ Approval gate checklist
   └─ Phase 2 readiness verification

TOTAL: ~4,500 lines, ~22,000 words, 22+ diagrams

✅ STRATEGIC DECISIONS
───────────────────────────────────────────────────────────────────
Decision 1: Universal Agent Architecture
  └─ Single Issue Management Agent (Tier 1-3 deployment)
  └─ 90%+ code reuse, configuration-driven customization

Decision 2: Test Coverage Strategy
  └─ >90% multi-layer testing (~423 tests)
  └─ Unit (195), Integration (100), E2E (70), Multi-Repo (25), Performance (33)

Decision 3: Documentation with Diagrams
  └─ Comprehensive documentation (22+ Mermaid diagrams)
  └─ ARCHITECTURE.md, SKILL_WORKFLOWS.md, INTEGRATION_GUIDE.md, etc.

Decision 4: Parallel Implementation
  └─ 5 skills implemented in parallel (Weeks 2-3)
  └─ 3-4 developers, daily standups, weekly integration checkpoints

Decision 5: WordPress Support in Phase 5
  └─ Configuration-driven tier support (Tier 1-3)
  └─ Control Plane (aggressive), Plugins (moderate), Themes (conservative)

✅ MULTI-AGENT ECOSYSTEM
───────────────────────────────────────────────────────────────────
Issues Agent v2.1 (Content Quality)
  └─ Labels: type:*, category:*
  └─ Does: Type assignment, enrichment, acceptance criteria

Labeling Agent v2.2 (Dynamic Labels)
  └─ Labels: area:*, priority:*, status:*
  └─ Does: File patterns, branch detection, one-hot enforcement

Issue Management Agent (Operations)
  └─ Labels: meta:* (new, no conflicts)
  └─ Does: PR sync, stale detection, audits, health monitoring

Result: Three complementary agents with ZERO label conflicts

✅ PHASE 2 READINESS
───────────────────────────────────────────────────────────────────
For Decision-Makers:
  ✅ 5 strategic questions answered
  ✅ Risk mitigation documented
  ✅ Phase 5 roadmap established
  ✅ Ready for approval

For Development Team:
  ✅ Skill specifications complete (from OPENSPEC)
  ✅ GitHub issues created (#1786-#1792)
  ✅ Test coverage targets defined
  ✅ Documentation roadmap established

For Project Management:
  ✅ 4-week timeline (Aug 20-Sep 17)
  ✅ Team structure (3-4 developers)
  ✅ Integration checkpoints (weekly)
  ✅ Success metrics defined

NEXT STEPS
───────────────────────────────────────────────────────────────────
Week of Aug 20: Phase 2 Kickoff
  1. Assign developers to skills (#1786-#1792)
  2. Set up test infrastructure
  3. Create ARCHITECTURE.md and SKILL_WORKFLOWS.md
  4. Begin parallel implementation

STATUS: ✅ READY FOR PHASE 2 IMPLEMENTATION APPROVAL

Branch: feat/issue-management-agent-planning
Docs: 4,500+ lines, 22+ diagrams
Related: Issue #1771 (Epic), Skills #1786-#1792

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

* fix: Downgrade Babel to 7.x for Node 20 CI runner compatibility

CI runner uses Node 20.20.2, but Babel 8.x requires Node 22.18.0+.
Downgrading to Babel 7.25.0 restores compatibility.

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

* design: Phase 1 Specification — Portable Linting Agent (OpenSpec Complete)

OpenSpec Phase 1 deliverables for portable, organisation-wide linting agent.

**Specification & Planning:**
- SPECIFICATION.md: Architecture, requirements, design decisions, test strategy
- README.md: 4-phase project timeline with deliverables
- TEST_PLAN.md: 75+ test cases, 95%+ coverage target, E2E for 3 repo types
- AGENT_PROMPT_DRAFT.md: Full agent prompt with standards integration

**Design Highlights:**
- Single portable agent (no repo-type-specific variants)
- Auto-discovers canonical configs (ESLint, PHPCS, yamllint, etc.)
- Supports 8+ file types and Windows/Unix paths
- WordPress-compatible (plugins, themes, classic)
- Normalises findings across linter formats
- Generates actionable Markdown reports

**Next Steps (Phases 2-4):**
- Phase 2: Implement + enhance linting.agent.js
- Phase 3: 75+ tests with ≥95% coverage
- Phase 4: Documentation + deployment

Related GitHub issues TBD.

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

* docs: Link planning docs to GitHub issues #1818-1822

- Epic issue: #1818 (Linting Agent Design & Implementation)
- Phase 2: #1819 (Implementation)
- Phase 3: #1821 (Testing & Coverage)
- Phase 4: #1822 (Documentation & Deployment)

Also linked issues in PR #1817 comment.

* fix: Address CI validation checks

- Add Related Issues section to project README.md (fixes project linking validation)
- Update Mermaid diagrams with explicit WCAG color contrast styling
- Update PR description with proper template (linked issues, changelog, DoD checklist)

Addresses feedback from:
- Project Linking Validation (missing Related Issues)
- Mermaid Diagram Validation (color contrast)
- PR Template Enforcement (required sections)

* fix: Simplify Mermaid diagrams for validation compatibility

- Remove theme initialization configs that may cause validation issues
- Use simple quote syntax for node labels
- Keep diagram structure and readability intact
- Should resolve Mermaid diagram validation failures

* fix: Update Related Issues format to match linking standard

- Update column headers: 'Phase' → 'Purpose'
- Add status badges (🟡 In Progress, ⏰ Planned)
- Match LINKING_STANDARD.md format exactly
- Resolves project linking validation failure

---------

Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:dependencies Composer/npm dependency work lang:js JavaScript/TypeScript lang:json JSON config/content meta:needs-changelog Requires a changelog entry before merge priority:normal Default priority status:needs-review Awaiting code review type:design Design work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Linting Agent Design & Implementation (Phase 1-4 Epic)

1 participant