Revert "Wave 5 Issue #670 Phase 3: Standardize plugin and .github subdirectory READMEs"#726
Merged
Merged
Conversation
…director…" This reverts commit b790f28.
Contributor
|
Important Review skippedToo many files! This PR contains 299 files, which is 149 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (299)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
https://github.com/lightspeedwp/.github/blob/fe518fd8da3bb5ca47d996d372e848571320b19b/.github/SAVED_REPLIES.md .md#L1
This file has been renamed to .github/SAVED_REPLIES.md .md, leaving .github/SAVED_REPLIES.md missing even though the reviewed tree still links to it from .github/pull_request_template.md and CodeRabbit path instructions. As a result, users following the PR template's Saved Replies link and tooling targeting **/.github/SAVED_REPLIES.md will not find the index.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| npm install --prefix scripts js-yaml ajv | ||
| FILES=$(git diff --name-only ${{ github.sha }} ${{ github.base_ref || 'HEAD~1' }} | grep -E '\.md$' || true) | ||
| for f in $FILES; do | ||
| node scripts/validate-frontmatter.js "$f" |
There was a problem hiding this comment.
In the Meta Agent workflow's front-matter job, any run that actually finds changed Markdown files will fail with MODULE_NOT_FOUND because this commit calls scripts/validate-frontmatter.js, but the repository only contains scripts/validation/validate-frontmatter.js (confirmed with repo-wide path lookup in the reviewed tree). This breaks the Markdown/frontmatter validation path for PRs and pushes that reach this loop.
Useful? React with 👍 / 👎.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request reorganises and restructures the repository's AI and automation assets to align with the portable AI plugin restructure guidelines, migrating reusable instructions and updating templates. However, several critical issues were identified during the review: invalid YAML syntax in .coderabbit.yml due to un-commented list items; an ESLint configuration override in .eslint.config.cjs that causes parsing errors; broken links referencing a non-existent automation/ directory in .github/README.md; an accidentally renamed SAVED_REPLIES.md file; broken relative paths in .github/ISSUE_TEMPLATE/07-improvement.md; missing required frontmatter fields in the new file-organisation instructions; a hardcoded absolute local path in test-coverage-implementation.md; and an unnecessary .backup file committed to the repository.
Comment on lines
+288
to
+289
| - A canonical list of org wide default labels exists in this file "https://github.com/lightspeedwp/.github/blob/develop/.github/labels.yml" https://github.com/lightspeedwp/.github/blob/develop/.github/labeler.yml | ||
| - A set of labeler rules exist in this file "https://github.com/lightspeedwp/.github/blob/develop/.github/labeler.yml" |
Contributor
There was a problem hiding this comment.
These lines are un-commented list items directly under enabled: true, which results in invalid YAML syntax and will cause parsing failures. Please comment them out or remove them.
# - A canonical list of org wide default labels exists in this file "https://github.com/lightspeedwp/.github/blob/develop/.github/labels.yml" https://github.com/lightspeedwp/.github/blob/develop/.github/labeler.yml
# - A set of labeler rules exist in this file "https://github.com/lightspeedwp/.github/blob/develop/.github/labeler.yml"
Comment on lines
+177
to
178
| files: ["**/*.js"], | ||
| languageOptions: { |
Contributor
There was a problem hiding this comment.
Because this block matches all **/*.js files and is defined after the ES Modules block, it will override the sourceType: "module" configuration for all .js files in scripts/ and .github/agents/. This will cause ESLint parsing errors on ES Module files. Adding ignores to this block prevents it from overriding the ES Modules configuration.
files: ["**/*.js"],
ignores: [
"scripts/**/*.js",
".github/agents/**/*.js",
".github/metrics/**/*.js",
".github/scripts/**/*.js",
"docs/ai/**/*.js"
],
languageOptions: {
Comment on lines
+222
to
+224
| - **Labels** ([automation/labels.yml](./automation/labels.yml)): Official label names, colours, and descriptions. | ||
| - **Labeler Rules** ([automation/labeler.yml](./automation/labeler.yml)): Automation for applying labels based on file paths, branch names, or PR type. | ||
| - **Issue Types** ([automation/issue-types.yml](./automation/issue-types.yml)): Machine-readable definitions mapping issue templates, types, and automation. |
Contributor
There was a problem hiding this comment.
These links reference a non-existent automation/ subdirectory. The files labels.yml, labeler.yml, and issue-types.yml are located directly under .github/. Please update the paths to point to the correct locations.
Suggested change
| - **Labels** ([automation/labels.yml](./automation/labels.yml)): Official label names, colours, and descriptions. | |
| - **Labeler Rules** ([automation/labeler.yml](./automation/labeler.yml)): Automation for applying labels based on file paths, branch names, or PR type. | |
| - **Issue Types** ([automation/issue-types.yml](./automation/issue-types.yml)): Machine-readable definitions mapping issue templates, types, and automation. | |
| - **Labels** ([labels.yml](./labels.yml)): Official label names, colours, and descriptions. | |
| - **Labeler Rules** ([labeler.yml](./labeler.yml)): Automation for applying labels based on file paths, branch names, or PR type. | |
| - **Issue Types** ([issue-types.yml](./issue-types.yml)): Machine-readable definitions mapping issue templates, types, and automation. |
Comment on lines
+253
to
+260
| - For more detail, see [AUTOMATION_GOVERNANCE.md](./automation/AUTOMATION_GOVERNANCE.md) and [ISSUE_LABELS.md](./automation/ISSUE_LABELS.md). | ||
|
|
||
| **Quick links:** | ||
|
|
||
| - [Label Definitions](./labels.yml) | ||
| - [Labeler Rules](./labeler.yml) | ||
| - [Issue Types](./issue-types.yml) | ||
| - [Automation Governance](../docs/AUTOMATION_GOVERNANCE.md) | ||
| - [Label Definitions](./automation/labels.yml) | ||
| - [Labeler Rules](./automation/labeler.yml) | ||
| - [Issue Types](./automation/issue-types.yml) | ||
| - [Automation Governance](./automation/AUTOMATION_GOVERNANCE.md) |
Contributor
There was a problem hiding this comment.
These links reference a non-existent automation/ subdirectory. The files labels.yml, labeler.yml, and issue-types.yml are located directly under .github/, and AUTOMATION_GOVERNANCE.md is located in docs/ (which is ../docs/ relative to .github/). Please update the paths to point to the correct locations.
Suggested change
| - For more detail, see [AUTOMATION_GOVERNANCE.md](./automation/AUTOMATION_GOVERNANCE.md) and [ISSUE_LABELS.md](./automation/ISSUE_LABELS.md). | |
| **Quick links:** | |
| - [Label Definitions](./labels.yml) | |
| - [Labeler Rules](./labeler.yml) | |
| - [Issue Types](./issue-types.yml) | |
| - [Automation Governance](../docs/AUTOMATION_GOVERNANCE.md) | |
| - [Label Definitions](./automation/labels.yml) | |
| - [Labeler Rules](./automation/labeler.yml) | |
| - [Issue Types](./automation/issue-types.yml) | |
| - [Automation Governance](./automation/AUTOMATION_GOVERNANCE.md) | |
| - For more detail, see [AUTOMATION_GOVERNANCE.md](../docs/AUTOMATION_GOVERNANCE.md) and [ISSUE_LABELS.md](../docs/ISSUE_LABELS.md). | |
| **Quick links:** | |
| - [Label Definitions](./labels.yml) | |
| - [Labeler Rules](./labeler.yml) | |
| - [Issue Types](./issue-types.yml) | |
| - [Automation Governance](../docs/AUTOMATION_GOVERNANCE.md) |
References
- Documentation and governance files in the docs/ directory must use UPPERCASE naming with underscores.
| @@ -104,3 +104,117 @@ Located in [`.github/SAVED_REPLIES/technical/`](./SAVED_REPLIES/technical/) | |||
| | [api-integration.md](./SAVED_REPLIES/technical/api-integration.md) | API support/troubleshooting | | |||
|
|
|||
| --- | |||
Contributor
There was a problem hiding this comment.
The file has been accidentally renamed to .github/SAVED_REPLIES.md .md (with a trailing space and duplicate extension) instead of .github/SAVED_REPLIES.md. Please rename the file back to .github/SAVED_REPLIES.md to maintain correct paths and prevent broken links.
Comment on lines
+12
to
+14
| - .github/labeler.yml | ||
| - .github/labels.yml | ||
| - .github/issue-types.yml |
Contributor
There was a problem hiding this comment.
The relative paths in the references section are broken. Since this file is located in .github/ISSUE_TEMPLATE/, the relative path to files directly under .github/ should use ../ instead of .github/.
Suggested change
| - .github/labeler.yml | |
| - .github/labels.yml | |
| - .github/issue-types.yml | |
| - ../labeler.yml | |
| - ../labels.yml | |
| - ../issue-types.yml |
Comment on lines
+1
to
+5
| --- | ||
| applyTo: "**" | ||
| description: "Canonical file organisation rules for GitHub-native governance files, portable AI assets, project artefacts, reports, and temporary outputs." | ||
| status: "active" | ||
| --- |
Contributor
There was a problem hiding this comment.
This newly added instruction file is missing several required frontmatter fields (file_type, title, version, last_updated, owners, tags, stability, domain) defined in the repository's frontmatter schema. Please update the frontmatter to be fully compliant.
Suggested change
| --- | |
| applyTo: "**" | |
| description: "Canonical file organisation rules for GitHub-native governance files, portable AI assets, project artefacts, reports, and temporary outputs." | |
| status: "active" | |
| --- | |
| --- | |
| file_type: "instructions" | |
| title: "File and Folder Organisation Instructions" | |
| description: "Canonical file organisation rules for GitHub-native governance files, portable AI assets, project artefacts, reports, and temporary outputs." | |
| version: "v1.0" | |
| last_updated: "2026-05-20" | |
| owners: ["LightSpeed Team"] | |
| tags: ["file-organisation", "governance", "structure"] | |
| applyTo: "**" | |
| status: "active" | |
| stability: "stable" | |
| domain: "governance" | |
| --- |
Comment on lines
61
to
65
| - [ ] Navigate to project root: | ||
|
|
||
| ```bash | ||
| cd /Users/ash/.codex/worktrees/epic-449-label-governance | ||
| cd /Users/ash/Studio/.github | ||
| ``` |
Contributor
There was a problem hiding this comment.
This line contains a hardcoded absolute local path (/Users/ash/Studio/.github) specific to a single user's machine. To ensure portability and ease of collaboration, please replace it with a generic placeholder, such as:
cd path/to/project-root| @@ -0,0 +1,989 @@ | |||
| --- | |||
Contributor
There was a problem hiding this comment.
Committing .backup files to the repository is a bad practice. Git handles version history, making backup files redundant and cluttering the codebase. Please remove this file and ensure .backup files are added to .gitignore.
This was referenced Jun 1, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Reverts #703