chore: consolidate documentation and create standardised prompts#637
Conversation
|
Warning Review limit reached
More reviews will be available in 29 minutes and 21 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (21)
📝 WalkthroughWalkthroughThis PR executes Phase 1 and Phase 2 of the documentation consolidation initiative: it consolidates five overlapping labeling/automation guidance files into two canonical guides (AUTOMATION.md, LABELING.md), establishes a standardised prompts directory with seven reusable templates, updates migration tracking, refines the metrics workflow, and refreshes supporting references. ChangesDocumentation Consolidation & Migration
Standardized Prompts Directory
Workflow Refinement & Support Updates
🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly Related PRs
Suggested Labels
Suggested Reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
Adds YAML frontmatter to all prompt template files to meet LightSpeed documentation standards. Each prompt now includes: - file_type: 'prompt' - title: Descriptive title - description: Brief description of prompt purpose Also adds frontmatter to prompts/README.md to comply with file validation. Fixes frontmatter validation errors in PR #637.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request consolidates and refines the repository's documentation structure by merging several redundant labeling and automation files into comprehensive guides (docs/LABELING.md and docs/AUTOMATION.md), deleting the deprecated files, and updating the deprecation index in instructions/DEPRECATED.md. It also introduces a standardized /prompts directory containing reusable prompt templates for AI agents. The reviewer feedback is highly constructive, pointing out broken relative links in docs/AUTOMATION.md, an incorrect path and naming convention violation in instructions/DEPRECATED.md, and recommending that the migration guide be relocated to a central /docs/MIGRATION.md file.
github-actions
Bot
added
status:needs-review
🔍 Reviewer Summary for PR #637CI Status: ❌ Recommendations
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR consolidates duplicated governance documentation into fewer canonical guides and introduces a reusable prompt-template library to standardise common AI/agent workflows across the repository.
Changes:
- Consolidated labelling and automation/workflow documentation, removing redundant legacy docs and adding a workflow coordination reference.
- Added a new
/promptsdirectory containing standardised prompt templates plus a usage README. - Updated migration/deprecation docs and changelog; made a small adjustment to the
metrics-summaryworkflow’s discussion-posting script.
Reviewed changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated 27 comments.
Show a summary per file
| File | Description |
|---|---|
| prompts/agent-setup.prompt | New reusable agent setup prompt template. |
| prompts/code-generation.prompt | New code generation prompt template. |
| prompts/code-review.prompt | New code review prompt template. |
| prompts/debugging.prompt | New debugging prompt template. |
| prompts/documentation.prompt | New documentation prompt template. |
| prompts/refactoring.prompt | New refactoring prompt template. |
| prompts/testing.prompt | New testing prompt template. |
| prompts/README.md | Documents the prompts library and usage. |
| docs/LABELING.md | Consolidates prior labelling docs into a single guide. |
| docs/AUTOMATION.md | Consolidates automation/workflow governance docs into a single guide. |
| docs/WORKFLOW_COORDINATION.md | Adds workflow coordination patterns/reference doc. |
| docs/MIGRATION.md | Updates migration guidance for renamed/consolidated docs. |
| instructions/DEPRECATED.md | Expanded deprecation index for consolidated/relocated docs. |
| CHANGELOG.md | Records the consolidation and prompts-library changes. |
| .github/workflows/metrics-summary.yml | Tweaks discussion body generation for weekly metrics summary posting. |
| docs/LABEL_STRATEGY.md | Deleted (content consolidated into docs/LABELING.md). |
| docs/ISSUE_LABELS.md | Deleted (content consolidated into docs/LABELING.md). |
| docs/PR_LABELS.md | Deleted (content consolidated into docs/LABELING.md). |
| docs/AUTOMATION_GOVERNANCE.md | Deleted (content consolidated into docs/AUTOMATION.md). |
| docs/WORKFLOWS.md | Deleted (content consolidated into docs/AUTOMATION.md). |
| #### Workflow Coordination Documentation | ||
|
|
||
| 1. **Advance notice** (at least 2 releases or 1 month notice) | ||
| 2. **Deprecation warnings** in documentation | ||
| 3. **Migration guide** in this file | ||
| 4. **Major version bump** when released | ||
| 5. **Clear communication** to all stakeholders | ||
| - Any link to `.github/docs/workflow-coordination.md` → change to `docs/WORKFLOW_COORDINATION.md` | ||
|
|
| - Consolidated labeling documentation: merged `docs/LABEL_STRATEGY.md`, `docs/ISSUE_LABELS.md`, `docs/PR_LABELS.md` into single comprehensive `docs/LABELING.md` (now 380+ lines covering strategy, issue/PR/discussion labeling, agent integration, and best practices) | ||
| - Consolidated automation documentation: merged `docs/AUTOMATION_GOVERNANCE.md`, `docs/WORKFLOWS.md` into single `docs/AUTOMATION.md` (now 450+ lines covering strategy, governance, workflow registry, and configuration management) | ||
| - Corrected nested file path: moved `.github/.github/docs/workflow-coordination.md` to `.github/docs/workflow-coordination.md` | ||
| - Updated `instructions/DEPRECATED.md` with deprecation index and migration guide for consolidated files |
| category_id: 'general' | ||
| }); |
| ### Configuration Files | ||
|
|
||
| - `.github/labels.yml` — Canonical label definitions, colors, and aliases | ||
| - `.github/labeler.yml` — File/branch-based label rules | ||
| - `.github/issue-types.yml` — Canonical issue type definitions |
| --- | ||
| file_type: "prompt" | ||
| --- | ||
| file_type: "prompt" | ||
| title: "Standardised Prompts Directory" | ||
| description: "Reusable prompt templates for agents and AI scenarios across LightSpeed projects" | ||
| --- |
| - **[refactoring.prompt](./refactoring.prompt)** — Code refactoring, optimisation, and modernisation | ||
| ## Usage |
| 1. **Justification:** Document why the label is needed | ||
| 3. **Naming Convention:** Follow `family:name` format (e.g., `status:in-progress`, `area:ci`) | ||
| 4. **Colour Coding:** Use category-appropriate colours: | ||
| - Status: Blue tones | ||
| - Priority: Red/Orange gradient | ||
| - Type: Green (features), Red (bugs), Purple (docs) | ||
| - Area/Component: Light blue | ||
| - Meta: Grey | ||
| - Meta: Grey | ||
| 5. **Description:** Provide clear, concise purpose | ||
| 6. **Documentation:** Update [Labeling Guide](./LABELING.md) with new label details |
| const reportContent = `${{ steps.read_report.outputs.content }}`; | ||
| const serverUrl = `${{ github.server_url }}`; | ||
| const repository = `${{ github.repository }}`; | ||
| const body = reportContent + '\n\n---\n\n*Generated by metrics-summary workflow. [View full reports](' + serverUrl + '/' + repository + '/tree/develop/.github/reports/metrics/)*'; |
|
|
||
| # Debugging Prompt Template | ||
|
|
||
| Use this prompt when diagnosing problems, analyzing root causes, or resolving issues. |
| - Assert [specific output/behavior for test 1] | ||
| - Assert [specific output/behavior for test 2] |
|
|
||
| ### Test Structure | ||
|
|
||
| ``` |
| Use this prompt when planning code refactoring, optimisation, or modernisation. | ||
| ## Context |
| ### In Scope | ||
|
|
||
| - [Files/modules to refactor] | ||
| - [Patterns/approaches to modernize] |
| 1. **Justification:** Document why the label is needed | ||
| 3. **Naming Convention:** Follow `family:name` format (e.g., `status:in-progress`, `area:ci`) | ||
| 4. **Colour Coding:** Use category-appropriate colours: | ||
| - Status: Blue tones | ||
| - Priority: Red/Orange gradient | ||
| - Type: Green (features), Red (bugs), Purple (docs) | ||
| - Area/Component: Light blue | ||
| - Meta: Grey | ||
| - Meta: Grey | ||
| 5. **Description:** Provide clear, concise purpose | ||
| 6. **Documentation:** Update [Labeling Guide](./LABELING.md) with new label details |
…ter validation, code fence language tags, template injection security, and documentation fixes
There was a problem hiding this comment.
Actionable comments posted: 19
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CHANGELOG.md`:
- Around line 33-39: Choose approach 1 (keep the actual filename
`docs/LABELING.md` and change the prose to UK spelling): update the entry to use
"labelling" everywhere in the description (e.g., change "issue/PR/discussion
labeling" to "issue/PR/discussion labelling") while leaving the filename
`docs/LABELING.md` as-is, and wrap the nested path
`.github/.github/docs/workflow-coordination.md` in backticks for consistency;
ensure all other occurrences in this entry follow UK English (optimise,
organisation, colour, behaviour, analyse).
In `@docs/AUTOMATION.md`:
- Line 163: The heading "Labeling and label sync workflows" and other
occurrences use US spelling; change them to UK English ("Labelling" and
"labelling") where the word describes the process (not filenames). Update the
text in docs/AUTOMATION.md — specifically the heading currently "Labeling and
label sync workflows" and the other two instances referenced — to use
"Labelling" in prose and keep filenames unchanged if any; ensure consistency
across the document (e.g., "labelling", "label sync workflows") so all process
descriptions follow UK spelling conventions.
- Around line 1-5: The frontmatter in AUTOMATION.md is missing required YAML
fields; update the frontmatter block (the existing keys file_type, title,
description) to include version, last_updated, owners, tags, status, stability,
and domain by adding those keys with appropriate values (e.g., version: "1.0",
last_updated: "YYYY-MM-DD", owners: ["team@org.com"], tags:
["automation","workflow"], status: "draft|active", stability:
"stable|experimental", domain: "engineering"). Ensure the YAML remains at the
top of the file and follows the same formatting style as the existing
frontmatter so all required metadata is present.
- Line 139: Update the UK English spelling in the docs by changing the phrase
"**Automation:** The labeling agent applies `type:*` labels based on issue type
field and title/body heuristics" to use "labelling" instead of "labeling";
search the AUTOMATION.md file for any other occurrences of "labeling" (e.g., the
phrase "labeling agent" or similar) and replace them with "labelling" so the
documentation conforms to the project's UK English wording standard.
- Line 66: Update the purpose text in the AUTOMATION.md table row that
references labeling.yml / labeling.agent.js: change "Unified labeling,
status/priority, and type automation" to UK English spelling "Unified labelling,
status/priority, and type automation" (keep the filename labeling.yml
unchanged); ensure any other occurrences in that row or nearby description use
"labelling" to comply with the project's UK English guideline.
- Around line 131-134: Update descriptive copy to UK English by replacing
occurrences of "labeling" with "labelling" in prose only: change "Labeling
Guide" display text to "Labelling Guide" (keep the link target ./LABELING.md
unchanged), change "labeling agent" to "labelling agent", and change "Automated
standardisation: The labeling agent ..." to use "labelling" while leaving the
filename `.github/labels.yml` and any file names or paths unchanged.
In `@docs/LABELING.md`:
- Line 154: Update the US spelling "Labeling" to UK English "Labelling" in the
document: replace the section heading "## Issue Labeling" and any other
occurrences of "Labeling" (notably the other headings/text instances referenced)
with "Labelling" so all headings and mentions use UK spelling consistently
across the file.
- Line 174: Replace US spelling "labeling" with UK spelling "labelling" in
descriptive text occurrences (e.g., the sentence "The unified labeling agent
enforces one-hot rules (exactly one status, one priority, one type)") and the
other mentioned descriptive passages; do not change filenames. Search for the
token "labeling" in the document content (not file names) and update each
occurrence to "labelling" while preserving surrounding wording and punctuation.
- Around line 1-5: The frontmatter block is missing required YAML keys; update
the existing frontmatter (the top --- block) to include version, last_updated,
owners, tags, status, stability, and domain, using a semantic version string for
version (e.g., "1.0.0"), an ISO date for last_updated, an array of owner
usernames/emails for owners, an array of tag strings for tags, a status value
(e.g., "draft" or "released"), a stability value (e.g., "stable" or
"experimental"), and a domain string; ensure keys are added alongside the
existing file_type, title, and description so the frontmatter conforms to
repository guidelines.
- Around line 1-7: Update the document metadata title and the main heading to
use UK English spelling: replace "GitHub Labeling & Automation" with "GitHub
Labelling & Automation" in the frontmatter title and change the H1 heading from
"# GitHub Labeling & Automation" to "# GitHub Labelling & Automation" so both
the file_type/title metadata and the heading text are consistent with the
project's UK English guideline.
- Around line 15-19: The TOC uses US spelling "Labeling" but the project uses UK
English; update all occurrences in the Table of Contents from "Labeling" to
"Labelling" (for example change "Issue Labeling", "Pull Request Labeling",
"Discussion Labeling" to "Issue Labelling", "Pull Request Labelling",
"Discussion Labelling") and ensure any internal anchor links or corresponding
section headings that contain "Labeling" are renamed to match the UK spelling so
anchors remain consistent (search for the string "Labeling" and replace with
"Labelling" in headings/links such as the existing "[Label Categories &
Families](`#label-categories--families`)" entries).
In `@docs/MIGRATION.md`:
- Line 20: Update the heading text "Labeling Documentation (Consolidated)" to
use UK English by changing it to "Labelling Documentation (Consolidated)"; also
scan the same document for the other occurrences mentioned (the strings at the
other noted locations) and replace US spellings with their UK equivalents (e.g.,
"labeling" → "labelling", "optimize" → "optimise") so the docs consistently
follow UK English orthography.
- Around line 1-8: The YAML frontmatter at the top (file_type, title,
description, version, last_updated, owners) is missing the required keys tags,
status, stability, and domain; update the frontmatter block by adding those four
keys with appropriate values (e.g., tags: [...], status: "draft|published",
stability: "stable|experimental", domain: "docs|api|guides") directly in the
existing YAML header so the file complies with the repository guideline that all
.md files include file_type, title, description, version, last_updated, owners,
tags, status, stability, and domain.
In `@instructions/DEPRECATED.md`:
- Around line 1-8: The frontmatter in DEPRECATED.md is missing required fields;
update the YAML block at the top of the file (the existing keys file_type,
title, description, version, last_updated, owners) to also include the required
keys tags, status, stability, and domain with appropriate values (e.g., tags:
[...], status: "deprecated" or "active", stability: "stable|beta|deprecated",
domain: "documentation|platform|..." as applicable) so the file conforms to the
repository frontmatter policy.
- Line 18: Replace the US spelling in the markdown heading "### Labeling
Documentation (Consolidated)" with UK English by changing it to "### Labelling
Documentation (Consolidated)"; ensure any other occurrences flagged (e.g., the
one noted at the other location) also use "Labelling" to conform with the
project's UK English wording convention.
In `@prompts/agent-setup.prompt`:
- Around line 1-5: Rename the template file prompts/agent-setup.prompt to
prompts/agent-setup.prompt.md and update its YAML frontmatter to satisfy the
prompt contract and repo docs schema: add required keys version, scope, role,
tags, inputs, outputs (with brief schemas/placeholders) and repo metadata
last_updated, author, maintainer, owners, status, stability, domain; ensure the
frontmatter is properly delimited with --- and retains existing file_type,
title, and description, and keep the body content unchanged aside from the
frontmatter rename and additions so discovery via
instructions/prompt.instructions.md and metadata validation succeed.
In `@prompts/documentation.prompt`:
- Around line 71-78: Update the example YAML frontmatter block so it includes
all required fields instead of the minimal set shown; specifically add version,
last_updated, owners, tags, stability, and domain alongside the existing
file_type, title, description, and status, and ensure the example uses realistic
placeholders (e.g., version: [e.g., 1.0.0], last_updated: [YYYY-MM-DD], owners:
[e.g., ["`@username`"]], tags: [e.g., ["documentation","guide"]], stability:
[stable/experimental/deprecated], domain: [e.g., automation/governance/tooling])
so users copying the example will produce complete frontmatter.
In `@prompts/README.md`:
- Around line 1-5: The frontmatter in the prompt file is missing required
fields; update the YAML frontmatter at the top of the file that currently
contains file_type, title, description to also include the required keys:
version, last_updated, owners, tags, status, stability, and domain (use the
existing title "Standardised Prompts Directory" as the document title). Populate
version with a semantic version like "1.0.0", last_updated with the current ISO
date, owners with an array of owner identifiers, tags with relevant keywords,
status with a repo-approved state (e.g., "draft" or "stable"), stability with a
value like "stable" or "experimental", and domain with the appropriate domain
string so the frontmatter block fully satisfies the repository guidelines.
- Around line 13-17: The README list of prompt templates is missing two entries;
add links for the missing templates by inserting
**[code-review.prompt](./code-review.prompt)** and
**[debugging.prompt](./debugging.prompt)** into the existing list so all seven
templates are listed alongside the existing **agent-setup.prompt**,
**code-generation.prompt**, **documentation.prompt**, **testing.prompt**, and
**refactoring.prompt** entries; ensure ordering and markdown style match the
surrounding items.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: ce9eb47a-ff5c-404b-848b-a140f314cb55
📒 Files selected for processing (21)
.github/workflows/metrics-summary.ymlCHANGELOG.mdagents/template.agent.mddocs/AUTOMATION.mddocs/AUTOMATION_GOVERNANCE.mddocs/ISSUE_LABELS.mddocs/LABELING.mddocs/LABEL_STRATEGY.mddocs/MIGRATION.mddocs/PR_LABELS.mddocs/WORKFLOWS.mddocs/WORKFLOW_COORDINATION.mdinstructions/DEPRECATED.mdprompts/README.mdprompts/agent-setup.promptprompts/code-generation.promptprompts/code-review.promptprompts/debugging.promptprompts/documentation.promptprompts/refactoring.promptprompts/testing.prompt
💤 Files with no reviewable changes (5)
- docs/AUTOMATION_GOVERNANCE.md
- docs/WORKFLOWS.md
- docs/ISSUE_LABELS.md
- docs/LABEL_STRATEGY.md
- docs/PR_LABELS.md
📜 Review details
🧰 Additional context used
📓 Path-based instructions (7)
**/*.{md,mdx,yaml,yml}
📄 CodeRabbit inference engine (CLAUDE.md)
Use UK English throughout (optimise, organisation, colour, behaviour)
Files:
agents/template.agent.mdinstructions/DEPRECATED.mdprompts/README.mddocs/LABELING.mdCHANGELOG.mddocs/AUTOMATION.mddocs/MIGRATION.md
**/*.md
📄 CodeRabbit inference engine (.github/instructions/markdown.instructions.md)
**/*.md: Use one H1 (#) per file; keep heading levels sequential (never skip from H2 to H4)
Use fenced code blocks with explicit language tags (bash,yaml,markdown, etc.)
Keep links relative for in-repo files; verify they resolve before merging
Use1.for ordered lists and-for unordered lists
Keep all wording in UK English (optimise, organisation, colour, behaviour, analyse)
Do not add areferences:frontmatter field — use inline links or a footer section instead
Blank lines before and after headings, code blocks, and block-level elements
Maximum line length: 120 characters (soft limit; prefer wrapping at natural sentence boundaries)
All.mdfiles in this repository should include YAML frontmatter with required fields: file_type, title, description, version, last_updated, owners, tags, status, stability, domain
Every image (![]()) must have descriptive alt text explaining the image's purpose, not its appearance. Empty alt (![ ]()) is valid only for purely decorative images
Link text must describe the destination — never use 'click here', 'read more', or bare URLs as visible text
Every table must have a header row (| Header |). Avoid merged cells
Use headings to communicate document structure, not for visual styling
Do not rely on colour alone to convey information in diagrams or callout blocks
Mermaid diagrams must includeaccTitleandaccDescrattributes for accessibility
Specify language in frontmatter; use plain language, avoid jargon where possible
Files:
agents/template.agent.mdinstructions/DEPRECATED.mdprompts/README.mddocs/LABELING.mdCHANGELOG.mddocs/AUTOMATION.mddocs/MIGRATION.md
**/{agents,ai}/**/*.{js,py,ts,tsx,md}
📄 CodeRabbit inference engine (AGENTS.md)
Each AI agent must have both a code file (.js, .py, etc.) and a spec (.md) following the agent template
Files:
agents/template.agent.md
instructions/**
⚙️ CodeRabbit configuration file
instructions/**: Review portable instruction files:
- Verify frontmatter follows the canonical pattern (file_type, version, last_updated, owners, tags, status, domain, stability).
- Flag any
references:frontmatter field — prohibited by CLAUDE.md.- Confirm the file has: Overview, General Rules, Detailed Guidance, Examples, Validation, and Cross-References sections.
- Check that language is UK English throughout.
Files:
instructions/DEPRECATED.md
**/docs/**/*.md
⚙️ CodeRabbit configuration file
**/docs/**/*.md: Review documentation files:
- Ensure markdown is linted and formatted per project style guides.
- Flag illogical folder structures, file naming, or misplaced content.
- Confirm documentation is up to date, accurate, and cross-referenced.
- Ensure accessibility (heading hierarchy, alt text for images, UK English).
Files:
docs/LABELING.mddocs/AUTOMATION.mddocs/MIGRATION.md
CHANGELOG.md
⚙️ CodeRabbit configuration file
CHANGELOG.md: Review CHANGELOG.md:
- Confirm entries follow Keep a Changelog 1.1.0 format.
- Each entry under [Unreleased] must include a PR link and issue link.
- Verify entries use the correct section headings (Added, Changed, Fixed, Deprecated, Removed, Security, Documentation, Performance).
- Check UK English spelling throughout.
Files:
CHANGELOG.md
**/.github/workflows/*.yml
⚙️ CodeRabbit configuration file
**/.github/workflows/*.yml: Review GitHub Actions workflows for this governance repo:
- Security: check for least-privilege permissions (use
permissions:at job level, default to read-only).- Secret handling: ensure secrets are passed via env vars, not interpolated directly into run: steps to prevent injection.
- Action pinning: prefer SHA-pinned actions over mutable tags (e.g.
actions/checkout@v4is acceptable; SHA pins are better).- No
pull_request_targetwith untrusted code execution unless explicitly justified.- Avoid storing sensitive outputs as unmasked step outputs.
- Check for reusable workflow patterns and matrix strategies where appropriate.
- Validate
on:triggers: ensure branch/path filters are present to avoid unnecessary runs.- Confirm workflows are documented, DRY, and maintainable.
- Ensure agent-triggered workflows use
workflow_dispatchwith defined inputs.
Files:
.github/workflows/metrics-summary.yml
🪛 LanguageTool
instructions/DEPRECATED.md
[uncategorized] ~53-~53: The official name of this software platform is spelled with a capital “H”.
Context: ...| Change Reason | | --- | --- | --- | | .github/.github/docs/workflow-coordination.md ...
(GITHUB)
[uncategorized] ~53-~53: The official name of this software platform is spelled with a capital “H”.
Context: ...docs/WORKFLOW_COORDINATION.md| Nested.github` directory removed; renamed to uppercas...
(GITHUB)
[duplication] ~79-~79: Possible typo: you repeated a word.
Context: ...d) — Consolidated labeling strategy and automation - Automation Guide — Consoli...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~81-~81: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...CLAUDE.md#repository-boundaries) — File organisation conventions ---
(OXFORD_SPELLING_Z_NOT_S)
prompts/README.md
[style] ~7-~7: Would you like to use the Oxford spelling “Standardized”? The spelling ‘Standardised’ is also correct.
Context: ...rios across LightSpeed projects" --- # Standardised Prompts This directory contains reusab...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~9-~9: Would you like to use the Oxford spelling “customize”? The spelling ‘customise’ is also correct.
Context: ...pts as starting points for common tasks—customise as needed for your specific context. #...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~17-~17: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...factoring.prompt)** — Code refactoring, optimisation, and modernisation ## Usage Each prom...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~17-~17: Would you like to use the Oxford spelling “modernization”? The spelling ‘modernisation’ is also correct.
Context: ...* — Code refactoring, optimisation, and modernisation ## Usage Each prompt is designed to b...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~23-~23: Would you like to use the Oxford spelling “Customizable”? The spelling ‘Customisable’ is also correct.
Context: ...ge Each prompt is designed to be: - Customisable: Adapt sections to your project conte...
(OXFORD_SPELLING_Z_NOT_S)
docs/LABELING.md
[uncategorized] ~29-~29: The official name of this software platform is spelled with a capital “H”.
Context: ...ollow a shared, canonical taxonomy (see .github/labels.yml). - Discoverability: La...
(GITHUB)
[style] ~38-~38: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...nonical labels use a family prefix. The organisation recognises the following label families...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~38-~38: Would you like to use the Oxford spelling “recognizes”? The spelling ‘recognises’ is also correct.
Context: ...s use a family prefix. The organisation recognises the following label families: ### Stat...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~76-~76: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...ange - type:performance — Performance optimisation - type:security — Security-related ch...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~92-~92: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...ards - area:performance — Performance optimisation - Other areas as needed **Component la...
(OXFORD_SPELLING_Z_NOT_S)
[misspelling] ~112-~112: This word is normally spelled as one.
Context: ...hase:** phase:1, phase:2, etc. (for multi-phase projects) - Device/Platform: `devic...
(EN_COMPOUNDS_MULTI_PHASE)
[uncategorized] ~170-~170: The official name of this software platform is spelled with a capital “H”.
Context: ...s or scope evolves - Labeler rules: .github/labeler.yml can auto-apply labels base...
(GITHUB)
[uncategorized] ~216-~216: Loose punctuation mark.
Context: ...s needed for your projects): - proto/, ds/, api/, schema/ — Product/desi...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~263-~263: Would you like to use the Oxford spelling “standardization”? The spelling ‘standardisation’ is also correct.
Context: ...tatus enforcement, type assignment, and standardisation are handled by the **unified labeling a...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~263-~263: The official name of this software platform is spelled with a capital “H”.
Context: ...g.agent.js) and **labeling workflow** (.github/workflows/labeling.yml`). **How it wor...
(GITHUB)
[uncategorized] ~268-~268: The official name of this software platform is spelled with a capital “H”.
Context: ...s 2. Reads canonical configuration from .github/labels.yml, .github/labeler.yml, and...
(GITHUB)
[uncategorized] ~268-~268: The official name of this software platform is spelled with a capital “H”.
Context: ...onfiguration from .github/labels.yml, .github/labeler.yml, and `.github/issue-types....
(GITHUB)
[style] ~288-~288: Would you like to use the Oxford spelling “standardization”? The spelling ‘standardisation’ is also correct.
Context: ...abel-reporting.js| Build labeling and standardisation reports | |type-lookup.js` | Load iss...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~308-~308: The official name of this software platform is spelled with a capital “H”.
Context: ...ually adjust when needed. 5. Refer to .github/labels.yml as the source of truth fo...
(GITHUB)
[uncategorized] ~309-~309: Do not mix variants of the same word (‘organise’ and ‘organize’) within a single text.
Context: ...scussion labels** to keep conversations organised and welcoming. 7. **Review and clean up...
(EN_WORD_COHERENCY)
[uncategorized] ~319-~319: The official name of this software platform is spelled with a capital “H”.
Context: ...Missing or incorrect labels?** - Check .github/labels.yml for missing/typo entries - ...
(GITHUB)
[uncategorized] ~331-~331: The official name of this software platform is spelled with a capital “H”.
Context: ...new label or modify rules?** 1. Update .github/labels.yml with the new canonical defi...
(GITHUB)
[uncategorized] ~332-~332: The official name of this software platform is spelled with a capital “H”.
Context: ... the new canonical definition 2. Update .github/labeler.yml if you need automatic appl...
(GITHUB)
[uncategorized] ~339-~339: The official name of this software platform is spelled with a capital “H”.
Context: ...quivalents - If a label persists, check .github/label-governance-policy.yml for except...
(GITHUB)
CHANGELOG.md
[uncategorized] ~34-~34: Do not mix variants of the same word (‘labelling’ and ‘labeling’) within a single text.
Context: ...` (covers strategy, issue/PR/discussion labelling, agent integration, and best practices)...
(EN_EXACT_COHERENCY_RULE)
[uncategorized] ~36-~36: The official name of this software platform is spelled with a capital “H”.
Context: ...) - Corrected nested file path: moved .github/.github/docs/workflow-coordination.md ...
(GITHUB)
[style] ~41-~41: Would you like to use the Oxford spelling “Standardized”? The spelling ‘Standardised’ is also correct.
Context: ...//issues/636)) - Standardised Prompts Directory — Created `/prompts...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~48-~48: Would you like to use the Oxford spelling “optimization”? The spelling ‘optimisation’ is also correct.
Context: ...refactoring.prompt` — Code refactoring, optimisation, and modernisation workflows - Each p...
(OXFORD_SPELLING_Z_NOT_S)
[style] ~48-~48: Would you like to use the Oxford spelling “modernization”? The spelling ‘modernisation’ is also correct.
Context: ...` — Code refactoring, optimisation, and modernisation workflows - Each prompt follows consi...
(OXFORD_SPELLING_Z_NOT_S)
docs/AUTOMATION.md
[grammar] ~53-~53: The plural noun “Workflows” cannot be used with the article “a”.
Context: ...o main only for tagging and deploying a release - Workflows: Release, Tag, Publish, Deployment ###...
(A_NNS)
[uncategorized] ~66-~66: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ...| Agent | | --- | --- | --- | --- | | labeling.yml | develop | Unified labeling, sta...
(EN_EXACT_COHERENCY_RULE)
[uncategorized] ~66-~66: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ... | labeling.yml | develop | Unified labeling, status/priority, and type automation |...
(EN_EXACT_COHERENCY_RULE)
[uncategorized] ~66-~66: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ... status/priority, and type automation | labeling.agent.js | | changelog-validate.yml...
(EN_EXACT_COHERENCY_RULE)
[style] ~73-~73: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...rics.yml** | develop | Track and report organisation metrics | metrics.agent.js | --- ## L...
(OXFORD_SPELLING_Z_NOT_S)
[duplication] ~124-~124: Possible typo: you repeated a word.
Context: ...:** - Alternative status/priority/type labels - Labels conflicting with canonical naming **Do...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~131-~131: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ... one type:* per issue/PR (enforced by labeling agent) - Minimum requirements: See ...
(EN_EXACT_COHERENCY_RULE)
[style] ~134-~134: Would you like to use the Oxford spelling “standardization”? The spelling ‘standardisation’ is also correct.
Context: ...s in .github/labels.yml - Automated standardisation: The labeling agent removes non-canon...
(OXFORD_SPELLING_Z_NOT_S)
[uncategorized] ~134-~134: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ...l` - Automated standardisation: The labeling agent removes non-canonical labels and ...
(EN_EXACT_COHERENCY_RULE)
[uncategorized] ~139-~139: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: .../issue-types.yml- **Automation:** The labeling agent appliestype:*` labels based on ...
(EN_EXACT_COHERENCY_RULE)
[uncategorized] ~215-~215: The official name of this software platform is spelled with a capital “H”.
Context: ... Required | | --- | --- | --- | --- | | .github/labels.yml | Label definitions, colour...
(GITHUB)
[uncategorized] ~216-~216: The official name of this software platform is spelled with a capital “H”.
Context: ...ses | Governance Team | 2 approvals | | .github/labeler.yml | File/branch-based label ...
(GITHUB)
[uncategorized] ~217-~217: The official name of this software platform is spelled with a capital “H”.
Context: ...les | Governance Team | 2 approvals | | .github/issue-types.yml | Issue type definitio...
(GITHUB)
[uncategorized] ~224-~224: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ...idate-labeling-configs.cjs` runs on all labeling PRs - Deployment: Configuration is ...
(EN_EXACT_COHERENCY_RULE)
[uncategorized] ~238-~238: Do not mix variants of the same word (‘labeling’ and ‘labelling’) within a single text.
Context: ...beling Guide](./LABELING.md) — Complete labeling strategy and label families - [Canonica...
(EN_EXACT_COHERENCY_RULE)
docs/MIGRATION.md
[style] ~49-~49: Consider using a different verb for a more formal wording.
Context: ...ollowing files were moved or renamed to correct structural issues and enforce naming co...
(FIX_RESOLVE)
[uncategorized] ~53-~53: The official name of this software platform is spelled with a capital “H”.
Context: ...| Change Reason | | --- | --- | --- | | .github/docs/workflow-coordination.md | `docs/...
(GITHUB)
[uncategorized] ~76-~76: The official name of this software platform is spelled with a capital “H”.
Context: ...ordination Documentation - Any link to .github/docs/workflow-coordination.md → change...
(GITHUB)
[duplication] ~103-~103: Possible typo: you repeated a word.
Context: ...d) — Consolidated labeling strategy and automation - Automation Guide — Consolidated ...
(ENGLISH_WORD_REPEAT_RULE)
[style] ~106-~106: Would you like to use the Oxford spelling “organization”? The spelling ‘organisation’ is also correct.
Context: ...CLAUDE.md#repository-boundaries) — File organisation conventions --- *Last updated: 2026-0...
(OXFORD_SPELLING_Z_NOT_S)
🪛 zizmor (1.25.2)
.github/workflows/metrics-summary.yml
[info] 138-138: code injection via template expansion (template-injection): may expand into attacker-controllable code
(template-injection)
🔇 Additional comments (10)
.github/workflows/metrics-summary.yml (3)
102-106: LGTM!
138-141: ⚡ Quick winNicely refactored discussion body construction! 🎯
The intermediate variables (
serverUrl,repository) make the link construction much clearer, and usingtoJson(...)to wrap the report content properly escapes special characters—this is actually the correct mitigation against injection, not a risk. The static analysis hint is a false positive here since the content originates from a repository-controlled file on the develop branch, not untrusted user input.
148-148: ⚡ Quick winRecheck
category_id: 1—can’t confirm against repo Discussion categories with current environment.The earlier
gh api graphqlcall failed because the owner/repo arguments were wrong, and the follow-up script also errored (nlnot found), so we still don’t have a category list to confirm whether node ID1exists (and is the intended “general”/default category).agents/template.agent.md (1)
122-122: LGTM!CHANGELOG.md (1)
41-50: ⚡ Quick winStandardised Prompts Directory: all seven templates are present ✅
The changelog’s seven prompt files all exist:prompts/agent-setup.prompt,prompts/code-generation.prompt,prompts/documentation.prompt,prompts/testing.prompt,prompts/code-review.prompt,prompts/debugging.prompt, andprompts/refactoring.prompt.
Double-check thatprompts/README.mdalso lists all seven (not just the five seen in the snippet) so the docs don’t leave anyone guessin’.prompts/code-generation.prompt (1)
1-92: LGTM!prompts/code-review.prompt (1)
1-143: LGTM!prompts/debugging.prompt (1)
1-146: LGTM!prompts/refactoring.prompt (1)
1-178: LGTM!prompts/testing.prompt (1)
1-129: LGTM!
| --- | ||
| file_type: "prompt" | ||
| title: "Agent Setup Prompt Template" | ||
| description: "Initial agent context, instructions, and operational guidelines" | ||
| --- |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if .prompt.md is the canonical extension per instructions
rg -n "prompt.md" instructions/prompt.instructions.md
# Check if there are other .prompt.md files in the repo
fd -e prompt.md -t fRepository: lightspeedwp/.github
Length of output: 195
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) Pull required frontmatter fields from instructions
echo "=== instructions/prompt.instructions.md (frontmatter requirements) ==="
rg -n "version|last_updated|owners|tags|status|stability|domain|file_type|title|description" instructions/prompt.instructions.md
echo
# 2) List all prompt template files currently present
echo "=== Files matching *.prompt (excluding *.prompt.md) ==="
fd -t f -e prompt | rg '\.prompt$' || true
echo
echo "=== Files matching *.prompt.md ==="
fd -t f -e md | rg '\.prompt\.md$' || true
echo
# 3) For the specific file mentioned in the review comment, show its YAML frontmatter block
TARGET="prompts/agent-setup.prompt"
if [ -f "$TARGET" ]; then
echo "=== YAML frontmatter for $TARGET ==="
awk 'NR==1{found=0} found==0 && $0=="---"{found=1} found==1{print; if($0=="---" && NR!=1){exit}}' "$TARGET"
else
echo "=== Expected file not found: $TARGET ==="
# try to locate similarly named file(s)
fd -t f "agent-setup.prompt" || true
fi
# 4) Parse all *.prompt files under any prompts/ directory for frontmatter keys
echo
echo "=== Frontmatter key audit for all *.prompt files ==="
python3 - <<'PY'
import subprocess, re, pathlib, sys
def sh(cmd):
return subprocess.check_output(cmd, shell=True, text=True).splitlines()
# get candidate files: any file ending with .prompt under paths containing 'prompts/'
paths = sh("fd -t f -e prompt | rg '/?prompts/.+\\.prompt$' || true")
if not paths:
# fallback: if 'prompts/' isn't in path, still consider .prompt files
paths = sh("fd -t f -e prompt | rg '\\.prompt$' || true")
req_keys = ["file_type","title","description","version","last_updated","owners","tags","status","stability","domain"]
def parse_frontmatter(p):
txt = pathlib.Path(p).read_text(encoding="utf-8", errors="ignore").splitlines()
if not txt or txt[0] != '---':
return None
# find closing ---
end = None
for i in range(1, len(txt)):
if txt[i].strip() == '---':
end = i
break
if end is None:
return None
block = "\n".join(txt[1:end])
keys = set()
for line in block.splitlines():
m = re.match(r'^([A-Za-z0-9_]+)\s*:', line.strip())
if m:
keys.add(m.group(1))
return keys
rows=[]
for p in paths:
keys = parse_frontmatter(p)
if keys is None:
rows.append((p, "NO_FRONT_MATTER"))
continue
missing = [k for k in req_keys if k not in keys]
rows.append((p, ",".join(missing) if missing else "OK"))
for p, status in rows:
print(f"{p}: {status}")
PYRepository: lightspeedwp/.github
Length of output: 1886
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Show the exact parts of prompt.instructions.md that define the required frontmatter keys and the canonical extension
echo "=== Extension guidance ==="
rg -n "prompt\\.md|\\.prompt\\.md|discoverability|applyTo" instructions/prompt.instructions.md
echo
echo "=== Stability/domain guidance ==="
rg -n "stability|domain" instructions/prompt.instructions.md
echo
echo "=== Frontmatter requirements section (context) ==="
# Print a chunk around the likely frontmatter requirement area
rg -n "frontmatter|YAML|file_type|owners|last_updated|version|status|tags" instructions/prompt.instructions.mdRepository: lightspeedwp/.github
Length of output: 257
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== occurrences of stability/domain in instructions/prompt.instructions.md ==="
rg -n "stability|domain" instructions/prompt.instructions.md || true
echo
echo "=== first 120 lines of instructions/prompt.instructions.md (for frontmatter requirements context) ==="
nl -ba instructions/prompt.instructions.md | head -n 120
echo
echo "=== search for frontmatter requirement lists mentioning required keys ==="
rg -n "frontmatter|YAML|required|must include|metadata" instructions/prompt.instructions.md
echo
echo "=== check if any other prompt instruction docs exist and mention stability/domain ==="
fd -t f -e md instructions | xargs -I{} sh -c 'echo "--- {} ---"; rg -n "stability|domain|\\.prompt\\.md" "{}" || true'Repository: lightspeedwp/.github
Length of output: 307
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== List markdown files under instructions/ ==="
fd -t f -e md instructions | sort
echo
echo "=== Prompt instructions file: first 220 lines ==="
cat -n instructions/prompt.instructions.md | head -n 220
echo
echo "=== Prompt instructions: any explicit required/metadata list cues ==="
rg -n "frontmatter|YAML|required|must include|metadata|owners|last_updated|version|tags|status|stability|domain|\\.prompt\\.md" instructions/prompt.instructions.md || true
echo
echo "=== Search all instructions/ for stability/domain ==="
rg -n "stability|domain" instructions || true
echo
echo "=== Search all instructions/ for .prompt.md guidance ==="
rg -n "\\.prompt\\.md|prompt\\.md extension|discoverability|applyTo" instructions || trueRepository: lightspeedwp/.github
Length of output: 11689
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== occurrences of file_type / prompt in prompt.instructions.md ==="
rg -n "file_type|file type|\\\"prompt\\\"|role\\s—|inputs\\s—|outputs\\s—|scope\\s—|Frontmatter Fields|All prompt files must" instructions/prompt.instructions.md
echo
echo "=== exact section 'Frontmatter Fields' (lines 25-45-ish) ==="
sed -n '20,50p' instructions/prompt.instructions.mdRepository: lightspeedwp/.github
Length of output: 346
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== Look for general frontmatter requirements across documentation formats ==="
rg -n "Every documentation file|must include|YAML frontmatter|frontmatter schema|owners|last_updated|status|stability|domain" instructions/documentation-formats.instructions.md
echo
echo "=== Show the area around 'Every documentation file must include YAML frontmatter' ==="
rg -n "Every documentation file" instructions/documentation-formats.instructions.mdRepository: lightspeedwp/.github
Length of output: 1833
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Show the frontmatter schema table area that lists required YAML keys + checkmarks
sed -n '200,270p' instructions/documentation-formats.instructions.md
echo
echo "=== Show the 'update last_updated' rule for context ==="
sed -n '250,290p' instructions/documentation-formats.instructions.mdRepository: lightspeedwp/.github
Length of output: 5159
🏁 Script executed:
#!/bin/bash
set -euo pipefail
for f in prompts/agent-setup.prompt prompts/code-review.prompt; do
echo "=== $f: first 40 lines ==="
cat -n "$f" | head -n 40
echo
doneRepository: lightspeedwp/.github
Length of output: 2868
Fix prompt template contract: rename to .prompt.md and complete required YAML frontmatter
- Extension mismatch:
instructions/prompt.instructions.mdexpects prompt files to use the.prompt.mdextension for discoverability, but the repo has 7 files namedprompts/*.prompt(no*.prompt.md). - YAML frontmatter is incomplete across all 7 templates: current frontmatter only includes
file_type,title,description. The prompt contract also requires at leastversion,scope,role,tags,inputs, andoutputs; additionally, the repo-wide documentation frontmatter schema requires metadata likelast_updated,author,maintainer,owners,status,stability, anddomain.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@prompts/agent-setup.prompt` around lines 1 - 5, Rename the template file
prompts/agent-setup.prompt to prompts/agent-setup.prompt.md and update its YAML
frontmatter to satisfy the prompt contract and repo docs schema: add required
keys version, scope, role, tags, inputs, outputs (with brief
schemas/placeholders) and repo metadata last_updated, author, maintainer,
owners, status, stability, domain; ensure the frontmatter is properly delimited
with --- and retains existing file_type, title, and description, and keep the
body content unchanged aside from the frontmatter rename and additions so
discovery via instructions/prompt.instructions.md and metadata validation
succeed.
- Add missing YAML frontmatter fields (version, last_updated, owners, tags, status, stability, domain) to all documentation and prompt files - Replace US spelling 'labeling' with UK spelling 'labelling' in prose throughout docs/AUTOMATION.md, docs/LABELING.md, docs/MIGRATION.md, CHANGELOG.md, and instructions/DEPRECATED.md (keep filenames unchanged) - Update section headings and title in docs/LABELING.md to use 'Labelling' instead of 'Labeling' - Update Table of Contents anchors in docs/LABELING.md to match new heading names - Add missing template entries to prompts/README.md (code-review.prompt, debugging.prompt) - Update example YAML frontmatter in prompts/documentation.prompt to show all required fields - Add complete frontmatter to all 7 prompt template files (agent-setup, code-generation, code-review, debugging, documentation, refactoring, testing) - Wrap nested file path in backticks in CHANGELOG.md for consistency - Fix table formatting in instructions/DEPRECATED.md with proper spacing Addresses 20 CodeRabbit review comments across 8 files. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
…ctory This commit streamlines repository documentation and creates reusable prompt templates: Documentation Consolidation: - Merge labeling documentation into single docs/LABELING.md (eliminates LABEL_STRATEGY.md, ISSUE_LABELS.md, PR_LABELS.md) - Merge automation governance into single docs/AUTOMATION.md (eliminates AUTOMATION_GOVERNANCE.md, WORKFLOWS.md) - Move workflow-coordination.md from nested .github/.github/docs to docs/ - Update instructions/DEPRECATED.md with deprecation index and migration guide - Maintain portable instructions for cross-repository reusability Standardised Prompts Directory: - Create /prompts directory with 7 reusable templates: - agent-setup.prompt - code-generation.prompt - documentation.prompt - testing.prompt - code-review.prompt - debugging.prompt - refactoring.prompt - Each follows consistent structure for reusability across agents and scenarios - Add prompts/README.md with usage guide Benefits: - Eliminated 5 redundant documentation files - Improved discoverability with single canonical sources - Enhanced maintainability by reducing duplication - Established reusable prompt library for agent scenarios Fixes #636 https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
Adds YAML frontmatter to all prompt template files to meet LightSpeed documentation standards. Each prompt now includes: - file_type: 'prompt' - title: Descriptive title - description: Brief description of prompt purpose Also adds frontmatter to prompts/README.md to comply with file validation. Fixes frontmatter validation errors in PR #637.
…ns, and migration guide location - Fix relative links in docs/AUTOMATION.md (lines 244-245): change ./.github/ to ../.github/ - Rename docs/workflow-coordination.md to docs/WORKFLOW_COORDINATION.md per uppercase naming convention - Create docs/MIGRATION.md as central repository for migration documentation - Update instructions/DEPRECATED.md to reference docs/MIGRATION.md instead of duplicating migration guide - Update path reference from .github/docs/ to docs/ in consolidation index
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency>
…ter validation, code fence language tags, template injection security, and documentation fixes
- Add missing YAML frontmatter fields (version, last_updated, owners, tags, status, stability, domain) to all documentation and prompt files - Replace US spelling 'labeling' with UK spelling 'labelling' in prose throughout docs/AUTOMATION.md, docs/LABELING.md, docs/MIGRATION.md, CHANGELOG.md, and instructions/DEPRECATED.md (keep filenames unchanged) - Update section headings and title in docs/LABELING.md to use 'Labelling' instead of 'Labeling' - Update Table of Contents anchors in docs/LABELING.md to match new heading names - Add missing template entries to prompts/README.md (code-review.prompt, debugging.prompt) - Update example YAML frontmatter in prompts/documentation.prompt to show all required fields - Add complete frontmatter to all 7 prompt template files (agent-setup, code-generation, code-review, debugging, documentation, refactoring, testing) - Wrap nested file path in backticks in CHANGELOG.md for consistency - Fix table formatting in instructions/DEPRECATED.md with proper spacing Addresses 20 CodeRabbit review comments across 8 files. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
ashleyshaw
force-pushed
the
feat/doc-consolidation-and-prompts
branch
from
c29988c to
5e89625
Compare
github-actions
Bot
added
type:documentation
* chore: consolidate documentation and create standardised prompts directory This commit streamlines repository documentation and creates reusable prompt templates: Documentation Consolidation: - Merge labeling documentation into single docs/LABELING.md (eliminates LABEL_STRATEGY.md, ISSUE_LABELS.md, PR_LABELS.md) - Merge automation governance into single docs/AUTOMATION.md (eliminates AUTOMATION_GOVERNANCE.md, WORKFLOWS.md) - Move workflow-coordination.md from nested .github/.github/docs to docs/ - Update instructions/DEPRECATED.md with deprecation index and migration guide - Maintain portable instructions for cross-repository reusability Standardised Prompts Directory: - Create /prompts directory with 7 reusable templates: - agent-setup.prompt - code-generation.prompt - documentation.prompt - testing.prompt - code-review.prompt - debugging.prompt - refactoring.prompt - Each follows consistent structure for reusability across agents and scenarios - Add prompts/README.md with usage guide Benefits: - Eliminated 5 redundant documentation files - Improved discoverability with single canonical sources - Enhanced maintainability by reducing duplication - Established reusable prompt library for agent scenarios Fixes #636 https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf * fix: add required frontmatter to prompt files and README Adds YAML frontmatter to all prompt template files to meet LightSpeed documentation standards. Each prompt now includes: - file_type: 'prompt' - title: Descriptive title - description: Brief description of prompt purpose Also adds frontmatter to prompts/README.md to comply with file validation. Fixes frontmatter validation errors in PR #637. * fix: resolve code review feedback on relative links, naming conventions, and migration guide location - Fix relative links in docs/AUTOMATION.md (lines 244-245): change ./.github/ to ../.github/ - Rename docs/workflow-coordination.md to docs/WORKFLOW_COORDINATION.md per uppercase naming convention - Create docs/MIGRATION.md as central repository for migration documentation - Update instructions/DEPRECATED.md to reference docs/MIGRATION.md instead of duplicating migration guide - Update path reference from .github/docs/ to docs/ in consolidation index * Apply suggestions from code review Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency> * fix: correct agents directory link in template.agent.md * Address copilot feedback on PR #637: UK English consistency, frontmatter validation, code fence language tags, template injection security, and documentation fixes * fix(ci): address CodeRabbit feedback from PR #637 - Add missing YAML frontmatter fields (version, last_updated, owners, tags, status, stability, domain) to all documentation and prompt files - Replace US spelling 'labeling' with UK spelling 'labelling' in prose throughout docs/AUTOMATION.md, docs/LABELING.md, docs/MIGRATION.md, CHANGELOG.md, and instructions/DEPRECATED.md (keep filenames unchanged) - Update section headings and title in docs/LABELING.md to use 'Labelling' instead of 'Labeling' - Update Table of Contents anchors in docs/LABELING.md to match new heading names - Add missing template entries to prompts/README.md (code-review.prompt, debugging.prompt) - Update example YAML frontmatter in prompts/documentation.prompt to show all required fields - Add complete frontmatter to all 7 prompt template files (agent-setup, code-generation, code-review, debugging, documentation, refactoring, testing) - Wrap nested file path in backticks in CHANGELOG.md for consistency - Fix table formatting in instructions/DEPRECATED.md with proper spacing Addresses 20 CodeRabbit review comments across 8 files. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf --------- Signed-off-by: Ash Shaw <ashley@lightspeedwp.agency> Co-authored-by: Claude <noreply@anthropic.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Summary
Streamlines repository documentation and creates a reusable prompts library for AI agents and scenarios. Eliminates 5 redundant documentation files while maintaining portable instructions for cross-repository use.
Changes
Documentation Consolidation
Labeling Documentation:
docs/LABEL_STRATEGY.md,docs/ISSUE_LABELS.md, anddocs/PR_LABELS.mdinto single comprehensivedocs/LABELING.md(380+ lines)instructions/labeling.instructions.mdfor cross-repository reusabilityAutomation Documentation:
docs/AUTOMATION_GOVERNANCE.mdanddocs/WORKFLOWS.mdinto singledocs/AUTOMATION.md(450+ lines)instructions/automation.instructions.mdfor cross-repository reusabilityFile Structure Corrections:
workflow-coordination.mdfrom nested.github/.github/docs/to correct pathdocs/workflow-coordination.mdinstructions/DEPRECATED.mdwith deprecation index and migration guide for consolidated filesStandardised Prompts Directory
Created
/promptsdirectory at repository root with 7 reusable prompt templates:Each prompt follows a consistent structure (Context, Task, Constraints, Acceptance Criteria, References) for reusability across agents and projects.
Added
prompts/README.mdwith usage guide and contribution guidelines.Benefits
Related Issue
Fixes #636
Test Plan
Generated by Claude Code