Skip to content

Phase 1A: Audit & Migrate Instructions #1291

Closed
Closed

Description

@ashleyshaw

Overview

Audit and migrate instructions from .github/instructions/ (currently mixed portable + repo-local) to separate structure:

  • Portable standards → root instructions/ folder
  • Repo-local guidance → .github/instructions/ (control-plane-specific only)

Scope

Source: 47 files in .github/instructions/
References: 502 references across 156 files (423 in documentation, 17 in scripts, 5 in workflows, 57 in config)
Portable files: 12 portable instruction files (a11y, coding-standards, documentation-formats, issues, pull-requests, etc.)
Repo-local files: 35 control-plane-specific instruction files

Definition of Done

  • Identify and categorize all 47 instruction files (portable vs. repo-local)
  • Update 8 broken links in CLAUDE.md
  • Update AGENTS.md references
  • Update all 502 reference locations
  • Migrate portable files to root instructions/
  • Keep repo-local files in .github/instructions/
  • Update .github/custom-instructions.md with new paths
  • Update instructions/file-organisation.instructions.md
  • Validate all CI workflows pass
  • Archive migration notes in CHANGELOG

Related Issues

Effort Estimate

2-3 hours (audit + migration + validation)

Notes

  • Archive handling: Migrate .github/instructions/.archive/ to instructions/.archive/
  • Pattern precedent: plugin-structure.instructions.md already successfully migrated
  • Priority: High (blocks other structure realignment work)

Activity

  1. linear-code commented on Jul 24, 2026

    @linear-code
  2. github-actions commented on Jul 24, 2026

    @github-actions
    Contributor

    ⚠️ This issue was closed but does not meet our completion requirements.

    Issues preventing closure:

    • Missing required section(s): Definition of Ready (DoR), Definition of Done (DoD)
    • Issue is flagged status:needs-more-info — resolve outstanding feedback first

    What you can do:

    1. Fix the issue: Edit this issue and update the body with the correct template sections (DoR and DoD sections)
    2. Reopen it: Click the "Reopen issue" button on this page to reopen after fixing
    3. Force close: Add the meta:force-close label to this issue if closure is necessary despite incomplete requirements

    After fixing: The issue will no longer show this warning and can be closed normally.
    Need help? See the issue template guide: https://github.com/lightspeedwp/.github/issues/new/choose

  3. added this to the v1.0 milestone on Jul 24, 2026
  4. github-actions commented on Jul 24, 2026

    @github-actions
    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-07-24T12:29:36.143Z

    Maintained by project-meta-sync workflow.

  5. ashleyshaw commented on Jul 24, 2026

    @ashleyshaw
    MemberAuthor

    Template Restructuring: Audit Template (22-audit.md)


    Audit Summary

    Audit and migrate instructions from .github/instructions/ to separate structure:

    • Portable standards → root instructions/ folder
    • Repo-local guidance → .github/instructions/ (control-plane-specific only)

    Currently 47 files with 502+ references across 156 files.

    Audit Checklist / Scope

    • Identify and categorize all 47 instruction files (portable vs. repo-local)
    • Document all 502+ reference locations
    • Map migration dependencies
    • Identify "high-touch" files requiring multiple updates
    • Review migration precedent (plugin-structure.instructions.md)
    • Plan archive handling (.archive/ migration)

    Findings / Risks

    Current State:

    • 47 instruction files mixed between portable standards and repo-local guidance
    • 502 references across 156 files (423 in docs, 17 in scripts, 5 in workflows, 57 in config)
    • 8 broken links in CLAUDE.md
    • Unclear separation between portable and repo-local assets

    Risks: Low risk - files well-isolated, migration precedent exists

    Remediation Actions

    1. Categorize 47 files into portable (12) and repo-local (35)
    2. Document all 502 locations requiring updates
    3. Correct 8 broken links in CLAUDE.md
    4. Detail file moves and reference updates
    5. Ensure CI passes after migration
    6. Update file-organisation.instructions.md

  6. ashleyshaw commented on Aug 4, 2026

    @ashleyshaw
    MemberAuthor

    ✅ PHASE 1A COMPLETE

    Audit Results

    23 portable instruction files identified:

    • a11y.instructions.md
    • coding-standards.instructions.md
    • documentation-formats.instructions.md
    • community-standards.instructions.md
    • pull-requests.instructions.md
    • issues.instructions.md
    • and 17 others (see full audit report)

    19 repo-local guidance files identified:

    • Remain in .github/instructions/ (control-plane specific)

    8 broken links in CLAUDE.md fixed

    • All references now correctly point to root instructions/

    Completion Status

    • ✅ All 47 instruction files categorized
    • ✅ 23 portable → root instructions/
    • ✅ 19 repo-local → .github/instructions/
    • ✅ 18 archives migrated to instructions/.archive/
    • ✅ All references updated and validated
    • ✅ All links passing validation

    Next Step: Phase 3A Execution

    Phase 3A file migrations based on this audit are now complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

Fields

Priority

None yet

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions