-
Notifications
You must be signed in to change notification settings - Fork 2
feat: initialize portable AI plugin restructuring project with comprehensive epic, batch, and issue planning documentation. #322
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
57 changes: 57 additions & 0 deletions
57
.github/projects/active/portable-ai-plugin-restructure/issues/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| title: "Portable AI Plugin Restructure Issue Drafts" | ||
| description: "Local parent and child GitHub issue drafts for the portable AI plugin restructure programme." | ||
| version: "v0.2.0" | ||
| last_updated: "2026-05-14" | ||
| file_type: "project" | ||
| maintainer: "LightSpeed Team" | ||
| authors: ["LightSpeed Team", "Codex"] | ||
| license: "GPL-3.0" | ||
| tags: ["issues", "planning", "ai-ops", "plugin", "restructure"] | ||
| domain: "governance" | ||
| stability: "active" | ||
| --- | ||
|
|
||
| # Portable AI Plugin Restructure Issue Drafts | ||
|
|
||
| These files are the local source drafts for the GitHub issues now posted to | ||
| `lightspeedwp/.github`. They use the repository issue templates from | ||
| `.github/ISSUE_TEMPLATE/` and now include live GitHub issue URLs in their | ||
| frontmatter. | ||
|
|
||
| ## Parent Epics | ||
|
|
||
| | Issue | Draft | Scope | | ||
| | --- | --- | --- | | ||
| | [#282](https://github.com/lightspeedwp/.github/issues/282) | `parents/01-epic-planning-control-and-skeleton.md` | [Epic] Portable AI plugin restructure: planning control and target skeleton | | ||
| | [#283](https://github.com/lightspeedwp/.github/issues/283) | `parents/02-epic-portable-source-migration.md` | [Epic] Portable AI plugin restructure: source asset migration | | ||
| | [#284](https://github.com/lightspeedwp/.github/issues/284) | `parents/03-epic-core-plugin-and-tool-compatibility.md` | [Epic] Portable AI plugin restructure: core plugin and compatibility | | ||
| | [#285](https://github.com/lightspeedwp/.github/issues/285) | `parents/04-epic-validation-docs-and-rollout.md` | [Epic] Portable AI plugin restructure: validation, docs, pilot, and release | | ||
|
|
||
| ## Child Issue Batches | ||
|
|
||
| | Batch | Folder | Purpose | Issues | | ||
| | --- | --- | --- | --- | | ||
| | 00 | `children/batch-00-planning-control/` | Foundation/planning | [#286](https://github.com/lightspeedwp/.github/issues/286), [#287](https://github.com/lightspeedwp/.github/issues/287), [#288](https://github.com/lightspeedwp/.github/issues/288) | | ||
| | 01 | `children/batch-01-skeleton-boundary/` | Target skeleton and .github boundary | [#289](https://github.com/lightspeedwp/.github/issues/289), [#290](https://github.com/lightspeedwp/.github/issues/290), [#291](https://github.com/lightspeedwp/.github/issues/291), [#292](https://github.com/lightspeedwp/.github/issues/292) | | ||
| | 02 | `children/batch-02-portable-migration/` | Portable source migration | [#293](https://github.com/lightspeedwp/.github/issues/293), [#294](https://github.com/lightspeedwp/.github/issues/294), [#295](https://github.com/lightspeedwp/.github/issues/295), [#296](https://github.com/lightspeedwp/.github/issues/296), [#297](https://github.com/lightspeedwp/.github/issues/297), [#298](https://github.com/lightspeedwp/.github/issues/298) | | ||
| | 03 | `children/batch-03-skills-cookbook/` | Skills and cookbook | [#299](https://github.com/lightspeedwp/.github/issues/299), [#300](https://github.com/lightspeedwp/.github/issues/300), [#301](https://github.com/lightspeedwp/.github/issues/301), [#302](https://github.com/lightspeedwp/.github/issues/302), [#303](https://github.com/lightspeedwp/.github/issues/303), [#304](https://github.com/lightspeedwp/.github/issues/304) | | ||
| | 04 | `children/batch-04-pilot-plugin/` | Pilot plugin package | [#305](https://github.com/lightspeedwp/.github/issues/305), [#306](https://github.com/lightspeedwp/.github/issues/306), [#307](https://github.com/lightspeedwp/.github/issues/307), [#308](https://github.com/lightspeedwp/.github/issues/308), [#309](https://github.com/lightspeedwp/.github/issues/309), [#310](https://github.com/lightspeedwp/.github/issues/310) | | ||
| | 05 | `children/batch-05-validation-reset/` | Validation reset | [#311](https://github.com/lightspeedwp/.github/issues/311), [#312](https://github.com/lightspeedwp/.github/issues/312), [#313](https://github.com/lightspeedwp/.github/issues/313), [#314](https://github.com/lightspeedwp/.github/issues/314), [#315](https://github.com/lightspeedwp/.github/issues/315), [#316](https://github.com/lightspeedwp/.github/issues/316) | | ||
| | 06 | `children/batch-06-pilot-release/` | Pilot, future packs, and release | [#317](https://github.com/lightspeedwp/.github/issues/317), [#318](https://github.com/lightspeedwp/.github/issues/318), [#319](https://github.com/lightspeedwp/.github/issues/319), [#320](https://github.com/lightspeedwp/.github/issues/320), [#321](https://github.com/lightspeedwp/.github/issues/321) | | ||
|
|
||
| ## Parent Mapping | ||
|
|
||
| - #282 owns batches 00 and 01. | ||
| - #283 owns batches 02 and 03. | ||
| - #284 owns batch 04, with #317 cross-linked for compatibility smoke testing. | ||
| - #285 owns batches 05 and 06. | ||
|
|
||
| ## Labels And Branch Prefixes | ||
|
|
||
| - Parent epics use `status:needs-planning`, `priority:important`, `type:epic`, and relevant area/type labels. | ||
| - AI operations work uses `type:ai-ops` and branch prefix `ai/`. | ||
| - Refactor work uses branch prefix `refactor/`. | ||
| - Documentation work uses branch prefix `docs/`. | ||
| - Build and validation work uses branch prefix `ci/` or `build/`. | ||
| - Maintenance work uses branch prefix `maintenance/` or `chore/`. | ||
59 changes: 59 additions & 0 deletions
59
...ch-00-planning-control/00-01-audit-current-asset-inventory-and-migration-map.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| name: "Audit" | ||
| about: "Propose, conduct, or document a security, accessibility, code, or process audit." | ||
| title: "[Audit] Inventory AI assets and create the migration decision map" | ||
| labels: [status:needs-audit, priority:important, type:ai-ops, area:core] | ||
| github_issue: "https://github.com/lightspeedwp/.github/issues/286" | ||
| github_parent: "https://github.com/lightspeedwp/.github/issues/282" | ||
| --- | ||
|
|
||
| ## Audit Summary | ||
|
|
||
| Audit every current AI and automation asset before files move. Produce the | ||
| canonical migration decision map for agents, instructions, prompts, schemas, | ||
| workflows, templates, saved replies, and scripts. | ||
|
|
||
| Parent epic: #282 (<https://github.com/lightspeedwp/.github/issues/282>). | ||
|
|
||
| ## Audit Checklist / Scope | ||
|
|
||
| - [ ] Inventory `.github/agents`, `.github/instructions`, `.github/prompts`, `.github/schemas`, `.github/workflows`, `scripts/agents`, and `scripts/validation`. | ||
| - [ ] Record decision for each item: keep, move, convert, archive, delete, or defer. | ||
| - [ ] Capture target path for every moved or converted asset. | ||
| - [ ] Flag assets with hard-coded `.github/*` paths. | ||
| - [ ] Store the table in the active project folder. | ||
|
|
||
| ## Findings / Risks | ||
|
|
||
| Known risks include stale paths, mixed repo/project AI guidance, and prompts | ||
| that may need conversion into skills or cookbook recipes. | ||
|
|
||
| ## Remediation Actions | ||
|
|
||
| - [ ] Link all follow-up child issues to rows in the migration map. | ||
| - [ ] Do not delete old paths until the map and link audit are complete. | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| - [ ] Audit scope and checklist completed. | ||
| - [ ] Findings and risks documented. | ||
| - [ ] Remediation actions assigned and tracked. | ||
| - [ ] Documentation/changelog updated if applicable. | ||
| - [ ] PR uses correct branch prefix `audit/`. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| Reference PRD section: "Phase 0: Freeze, Baseline, And Inventory". | ||
|
|
||
| ### Definition of Ready (DoR) | ||
|
|
||
| - [ ] Audit scope, checklist, and goals defined. | ||
| - [ ] Areas/components listed. | ||
| - [ ] Dependencies and standards mapped. | ||
|
|
||
| ### Definition of Done (DoD) | ||
|
|
||
| - [ ] Audit performed and findings documented. | ||
| - [ ] Remediation actions assigned. | ||
| - [ ] Documentation/changelog updated if applicable. | ||
| - [ ] PR uses correct branch prefix `audit/`. |
62 changes: 62 additions & 0 deletions
62
...tch-00-planning-control/00-02-audit-baseline-validation-and-dependency-state.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| name: "Audit" | ||
| about: "Propose, conduct, or document a security, accessibility, code, or process audit." | ||
| title: "[Audit] Capture baseline validation, test, and dependency state" | ||
| labels: [status:needs-audit, priority:important, area:ci, area:core] | ||
| github_issue: "https://github.com/lightspeedwp/.github/issues/287" | ||
| github_parent: "https://github.com/lightspeedwp/.github/issues/282" | ||
| --- | ||
|
|
||
| ## Audit Summary | ||
|
|
||
| Capture the current validation and dependency baseline before restructuring, | ||
| including `npm ci`, validators, tests, coverage output, and dependency audit | ||
| results. | ||
|
|
||
| Parent epic: #282 (<https://github.com/lightspeedwp/.github/issues/282>). | ||
|
|
||
| ## Audit Checklist / Scope | ||
|
|
||
| - [ ] Record current branch and commit. | ||
| - [ ] Run or document `npm ci`. | ||
| - [ ] Run `npm run validate:agents`. | ||
| - [ ] Run `npm run validate:workflows`. | ||
| - [ ] Run `npm run validate:json:schemas`. | ||
| - [ ] Run `npm test`. | ||
| - [ ] Run `npm audit` or capture existing vulnerability count. | ||
| - [ ] Note which commands are mutating or noisy. | ||
|
|
||
| ## Findings / Risks | ||
|
|
||
| Known baseline risks: invalid JSON comments in schema files, mutating | ||
| validation commands, zero coverage output, and dependency vulnerabilities. | ||
|
|
||
| ## Remediation Actions | ||
|
|
||
| - [ ] Convert findings into validation reset child issues. | ||
| - [ ] Keep raw command outputs or summaries in the active project folder. | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| - [ ] Audit scope and checklist completed. | ||
| - [ ] Findings and risks documented. | ||
| - [ ] Remediation actions assigned and tracked. | ||
| - [ ] Documentation/changelog updated if applicable. | ||
| - [ ] PR uses correct branch prefix `audit/`. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| This issue should not fix the findings; it records the pre-migration baseline. | ||
|
|
||
| ### Definition of Ready (DoR) | ||
|
|
||
| - [ ] Audit scope, checklist, and goals defined. | ||
| - [ ] Areas/components listed. | ||
| - [ ] Dependencies and standards mapped. | ||
|
|
||
| ### Definition of Done (DoD) | ||
|
|
||
| - [ ] Audit performed and findings documented. | ||
| - [ ] Remediation actions assigned. | ||
| - [ ] Documentation/changelog updated if applicable. | ||
| - [ ] PR uses correct branch prefix `audit/`. |
56 changes: 56 additions & 0 deletions
56
...00-planning-control/00-03-task-create-milestone-label-and-issue-linking-plan.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| name: "Task" | ||
| about: "Propose a well-scoped unit of work: template tweaks, config updates, copy edits, etc." | ||
| title: "[Task] Create milestone, label, and parent-child issue linking plan" | ||
| labels: [status:needs-triage, priority:normal, area:core] | ||
| assignees: [] | ||
| projects: [] | ||
| milestone: "" | ||
| file_type: task | ||
| github_issue: "https://github.com/lightspeedwp/.github/issues/288" | ||
| github_parent: "https://github.com/lightspeedwp/.github/issues/282" | ||
| --- | ||
|
|
||
| ## Task Summary | ||
|
|
||
| Define how the restructure issues will be posted, labelled, linked, and batched | ||
| in GitHub before creating the full issue set. | ||
|
|
||
| Parent epic: #282 (<https://github.com/lightspeedwp/.github/issues/282>). | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| - [ ] Milestone name and scope are defined. | ||
| - [ ] Parent epic issue order is documented. | ||
| - [ ] Child issue posting order is documented. | ||
| - [ ] Required labels are listed. | ||
| - [ ] Parent issue numbers are added back to local child drafts after posting. | ||
| - [ ] Correct branch prefix for PR: `chore/` or `task/`. | ||
|
|
||
| ## Steps / Checklist | ||
|
|
||
| - [ ] Choose milestone name, likely `Portable AI Plugin Restructure`. | ||
| - [ ] Create four parent epics first. | ||
| - [ ] Create child issues batch by batch. | ||
| - [ ] Add child issue links to parent epics. | ||
| - [ ] Update local issue drafts with GitHub issue numbers. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Depends on the local issue draft pack in this active project folder. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| This prevents losing track of issue relationships once drafts are posted to | ||
| GitHub. | ||
|
|
||
| ## Definition of Ready (DoR) | ||
|
|
||
| - [ ] Task described and scoped. | ||
| - [ ] Estimate added if relevant. | ||
|
|
||
| ## Definition of Done (DoD) | ||
|
|
||
| - [ ] Task completed and documented. | ||
| - [ ] Changelog entry prepared for PR. | ||
| - [ ] PR uses correct branch prefix. |
57 changes: 57 additions & 0 deletions
57
...children/batch-01-skeleton-boundary/01-01-task-create-target-folder-skeleton.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| name: "Task" | ||
| about: "Propose a well-scoped unit of work: template tweaks, config updates, copy edits, etc." | ||
| title: "[Task] Create target top-level folder skeleton" | ||
| labels: [status:needs-triage, priority:important, area:core] | ||
| assignees: [] | ||
| projects: [] | ||
| milestone: "" | ||
| file_type: task | ||
| github_issue: "https://github.com/lightspeedwp/.github/issues/289" | ||
| github_parent: "https://github.com/lightspeedwp/.github/issues/282" | ||
| --- | ||
|
|
||
| ## Task Summary | ||
|
|
||
| Create the requested top-level folder structure without moving production | ||
| assets yet. | ||
|
|
||
| Parent epic: #282 (<https://github.com/lightspeedwp/.github/issues/282>). | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| - [ ] `/.schemas` exists. | ||
| - [ ] `/agents` exists. | ||
| - [ ] `/cookbook` exists. | ||
| - [ ] `/hooks` exists. | ||
| - [ ] `/instructions` exists. | ||
| - [ ] `/plugins` exists. | ||
| - [ ] `/skills` exists. | ||
| - [ ] `/workflows` exists. | ||
| - [ ] Existing `.github` behaviour is unchanged. | ||
| - [ ] Correct branch prefix for PR: `chore/` or `task/`. | ||
|
|
||
| ## Steps / Checklist | ||
|
|
||
| - [ ] Add `.gitkeep` or README/index placeholders where needed. | ||
| - [ ] Avoid moving existing files in this issue. | ||
| - [ ] Confirm `git status` only shows new skeleton files. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| Depends on the approved PRD and target structure. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| This is intentionally a tiny first implementation slice. | ||
|
|
||
| ## Definition of Ready (DoR) | ||
|
|
||
| - [ ] Task described and scoped. | ||
| - [ ] Estimate added if relevant. | ||
|
|
||
| ## Definition of Done (DoD) | ||
|
|
||
| - [ ] Task completed and documented. | ||
| - [ ] Changelog entry prepared for PR. | ||
| - [ ] PR uses correct branch prefix. |
54 changes: 54 additions & 0 deletions
54
.../children/batch-01-skeleton-boundary/01-02-document-folder-ownership-indexes.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| name: "Documentation" | ||
| about: "Request new documentation or propose updates/clarifications to existing docs." | ||
| title: "[Documentation] Add ownership indexes for new top-level folders" | ||
| labels: [status:needs-triage, priority:normal, area:documentation] | ||
| github_issue: "https://github.com/lightspeedwp/.github/issues/290" | ||
| github_parent: "https://github.com/lightspeedwp/.github/issues/282" | ||
| --- | ||
|
|
||
| ## What documentation is needed? | ||
|
|
||
| Add README or index files explaining ownership, allowed content, and migration | ||
| rules for the new top-level folders. | ||
|
|
||
| Parent epic: #282 (<https://github.com/lightspeedwp/.github/issues/282>). | ||
|
|
||
| ## Why is this documentation important? | ||
|
|
||
| The restructure changes long-standing `.github` placement rules. Each folder | ||
| needs a clear contract so future agents and maintainers do not recreate the | ||
| same ambiguity. | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| - [ ] `/.schemas/README.md` explains schema ownership. | ||
| - [ ] `/agents/README.md` explains portable agent specs. | ||
| - [ ] `/cookbook/README.md` explains recipes and examples. | ||
| - [ ] `/hooks/README.md` explains safe hooks and adapters. | ||
| - [ ] `/instructions/README.md` explains portable instruction scope. | ||
| - [ ] `/plugins/README.md` explains plugin family strategy. | ||
| - [ ] `/skills/README.md` explains skill folder rules. | ||
| - [ ] `/workflows/README.md` distinguishes agentic workflows from GitHub Actions. | ||
| - [ ] Documentation is accessible and easy to find. | ||
| - [ ] PR uses correct branch prefix `docs/`. | ||
|
|
||
| ## Additional Context | ||
|
|
||
| Use UK English and keep the indexes concise. Link to the active PRD. | ||
|
|
||
| ## Definition of Ready (DoR) | ||
|
|
||
| - [ ] Documentation need is clear and well-defined. | ||
| - [ ] Related docs/issues or files linked. | ||
| - [ ] Acceptance criteria listed. | ||
| - [ ] Estimate added if relevant. | ||
| - [ ] Milestone/release assigned if applicable. | ||
|
|
||
| ## Definition of Done (DoD) | ||
|
|
||
| - [ ] Documentation meets org standards and guidelines. | ||
| - [ ] Changelog entry prepared for PR. | ||
| - [ ] Documentation reviewed for clarity and accessibility. | ||
| - [ ] Screenshots/code examples included if relevant. | ||
| - [ ] PR uses correct branch prefix `docs/`. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is an inconsistency between this rule and the actual issue drafts in Batches 03 and 04. While the README specifies the
ai/branch prefix fortype:ai-opswork, the drafts consistently use thefeat/prefix in their acceptance criteria. Please update the rule to includefeat/or align the drafts with theai/prefix.