diff --git a/instructions/a11y.instructions.md b/instructions/a11y.instructions.md index 624d7966..9f4a436c 100644 --- a/instructions/a11y.instructions.md +++ b/instructions/a11y.instructions.md @@ -1,4 +1,8 @@ --- +file_type: "instructions" +title: "Accessibility Instructions" description: "Guidance for creating more accessible code" +scope: "organization-wide" +status: "active" applyTo: "**" --- diff --git a/instructions/agent-spec.instructions.md b/instructions/agent-spec.instructions.md index 88b689a3..87b915e3 100644 --- a/instructions/agent-spec.instructions.md +++ b/instructions/agent-spec.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Agent Specification Instructions" description: "How to design, write, and review LightSpeed Copilot agent specification files." +scope: "repo-local" version: "v1.0" last_updated: "2025-12-11" owners: ["GitHub Community Health Team"] diff --git a/instructions/automation.instructions.md b/instructions/automation.instructions.md index 6cef5f85..3c161a59 100644 --- a/instructions/automation.instructions.md +++ b/instructions/automation.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Automation Standards" description: "Comprehensive standards for GitHub automation agents, workflows, and repository health management" +scope: "repo-local" version: "v1.0" last_updated: "2025-12-07" owners: ["GitHub Community Health Team"] diff --git a/instructions/coding-standards.instructions.md b/instructions/coding-standards.instructions.md index a0a6501d..81e2c306 100644 --- a/instructions/coding-standards.instructions.md +++ b/instructions/coding-standards.instructions.md @@ -1,11 +1,14 @@ --- file_type: "instructions" +title: "Coding Standards" description: "Unified coding standards for all LightSpeedWP projects: applies to all code, documentation, automation, and AI contributions." +scope: "organization-wide" applyTo: "**" version: "v2.1" last_updated: "2025-12-04" owners: ["LightSpeedWP Team"] tags: ["coding-standards", "governance", "automation", "docs", "lint", "ai"] +status: "active" --- # LightSpeedWP Coding Standards — Canonical Reference @@ -104,3 +107,11 @@ All documentation links to files within the same repository should use `/blob/HE - See [LightSpeed Copilot Prompts Index](../.github/prompts/prompts.md) for reusable prompts. --- + +## Related Files + +- **[linting.instructions.md](./linting.instructions.md)** — Tool-specific linting rules and configurations +- **[languages.instructions.md](./languages.instructions.md)** — Language-specific coding standards and formatting +- **[quality-assurance.instructions.md](./quality-assurance.instructions.md)** — Testing and QA standards + +--- diff --git a/instructions/community-standards.instructions.md b/instructions/community-standards.instructions.md index 71c81b5c..ab1a4ac7 100644 --- a/instructions/community-standards.instructions.md +++ b/instructions/community-standards.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Community Standards" description: "Community health standards: naming conventions, README expectations, saved replies, and shared assets. File placement lives in file-organisation.instructions.md." +scope: "organization-wide" version: "v1.0" last_updated: "2025-12-07" owners: ["GitHub Community Health Team"] diff --git a/instructions/copilot-operations.instructions.md b/instructions/copilot-operations.instructions.md index f71ff152..8307401f 100644 --- a/instructions/copilot-operations.instructions.md +++ b/instructions/copilot-operations.instructions.md @@ -1,5 +1,8 @@ --- -applyTo: "**" +file_type: "instructions" +title: "Copilot Operations" description: "Unified Copilot operating guide: behaviour guardrails and process logging with correct file placement." +scope: "repo-local" +applyTo: "**" status: "active" --- diff --git a/instructions/docs.instructions.md b/instructions/docs.instructions.md index 870b964a..d97805d2 100644 --- a/instructions/docs.instructions.md +++ b/instructions/docs.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Documentation Instructions" description: "Universal documentation standards for Markdown files in this repository unless overridden by more specific guidance." +scope: "repo-local" applyTo: "**/*.md" --- diff --git a/instructions/documentation-formats.instructions.md b/instructions/documentation-formats.instructions.md index 78e753a7..c16ee630 100644 --- a/instructions/documentation-formats.instructions.md +++ b/instructions/documentation-formats.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Documentation Formats Standards" description: "Unified standards for Markdown, YAML frontmatter, and Mermaid diagrams across all GitHub community health documentation" +scope: "organization-wide" version: "v1.1.1" last_updated: "2026-05-28" owners: ["GitHub Community Health Team"] @@ -601,3 +602,12 @@ jobs: - All checks required before merge --- + +## Related Files + +- **[coding-standards.instructions.md](./coding-standards.instructions.md)** — Code quality standards referenced in documentation +- **[issues.instructions.md](./issues.instructions.md)** — Issue documentation and templates +- **[pull-requests.instructions.md](./pull-requests.instructions.md)** — PR documentation and templates +- **[community-standards.instructions.md](./community-standards.instructions.md)** — Community health documentation standards + +--- diff --git a/instructions/file-organisation.instructions.md b/instructions/file-organisation.instructions.md index 602a811f..f2a7ec0f 100644 --- a/instructions/file-organisation.instructions.md +++ b/instructions/file-organisation.instructions.md @@ -1,5 +1,8 @@ --- -applyTo: "**" +file_type: "instructions" +title: "File Organisation" description: "Portable file organisation rules for GitHub-native governance files, portable AI assets, project artefacts, reports, and temporary outputs." +scope: "repo-local" +applyTo: "**" status: "active" --- diff --git a/instructions/hooks.instructions.md b/instructions/hooks.instructions.md index 53497d3d..96d12acc 100644 --- a/instructions/hooks.instructions.md +++ b/instructions/hooks.instructions.md @@ -1,4 +1,72 @@ --- -description: "Guidelines for authoring portable guardrail hooks with explicit inputs, outputs, and safety outcomes." -applyTo: "hooks/**" +file_type: "instructions" +title: "Hook File Instructions" +description: "Guidelines for authoring portable guardrail hooks with explicit inputs, outputs, and safety outcomes" +scope: "repo-local" +version: "v1.0" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["hooks", "guardrails", "safety", "automation", "validation"] +applyTo: ["hooks/**/*.md"] +status: "active" +--- + +# LightSpeed Hook File Instructions + +Create reusable, safety-focused hooks for pre-commit, CI/CD, and automation workflows. Hooks must have explicit guardrails and clear documentation. + +## General Rules + +- Hook files are stored in `hooks/` at repository root +- Each hook must have a clear purpose and trigger condition +- Document all inputs, outputs, and side effects explicitly +- Include safety constraints and guardrails upfront +- Test hooks locally before committing +- Use descriptive file names (e.g., `validate-commit-message.md`) + +## Hook Frontmatter + +- `title` — Descriptive name of the hook +- `description` — What it validates or enforces +- `version` — Semantic version +- `scope` — "organization-wide" (for reusable hooks) or "repo-local" +- `trigger` — When hook runs (pre-commit, pre-push, CI, etc.) +- `exit_code` — Success (0) and failure codes +- `tags` — Searchable keywords + +## Hook Structure + +1. **Purpose** — What safety risk or validation this hook addresses +2. **Trigger** — When and how the hook executes +3. **Input** — What data/files the hook receives +4. **Validation Rules** — Specific checks performed +5. **Output** — Success/failure messages +6. **Guardrails** — Constraints and limitations +7. **Examples** — Sample passing and failing cases + +## Safety Requirements + +All hooks must: + +- Fail safely (err on the side of caution) +- Have clear error messages +- Not require user secrets or credentials +- Be reversible or non-destructive +- Document any system changes +- Include rollback instructions if applicable + +## Testing Hooks + +- Test locally with various file types and edge cases +- Verify exit codes match documentation +- Ensure error messages are helpful +- Test on both success and failure paths + +--- + +## Related Files + +- [automation.instructions.md](./automation.instructions.md) — Automation standards and workflow integration +- [coding-standards.instructions.md](./coding-standards.instructions.md) — Code quality standards hooks enforce + --- diff --git a/instructions/instructions.instructions.md b/instructions/instructions.instructions.md index 500428b3..2492d36b 100644 --- a/instructions/instructions.instructions.md +++ b/instructions/instructions.instructions.md @@ -1,8 +1,11 @@ --- +file_type: "instructions" +title: "Instructions" description: "Guidelines for writing Copilot instruction files in the LightSpeed .github community health repository" +scope: "repo-local" +version: "v1.0" +last_updated: "2025-12-11" applyTo: "**/.github/instructions/*.instructions.md" -version: 1.0 -lastUpdated: 2025-12-11 --- # LightSpeed Organisation GitHub Instruction Authoring diff --git a/instructions/issues.instructions.md b/instructions/issues.instructions.md index b50c3804..285681db 100644 --- a/instructions/issues.instructions.md +++ b/instructions/issues.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Issue Creation Instructions" description: "Canonical instructions for creating, labeling, and managing Issues in LightSpeedWP projects. Reference for templates, types, automation, and labeling strategy." +scope: "organization-wide" version: "1.2" last_updated: "2026-05-28" owners: ["lightspeedwp/maintainers"] @@ -235,3 +236,11 @@ See [Issue Creation Guide](../docs/ISSUE_CREATION_GUIDE.md) for details. - Use the correct template and title prefix (`bug:`, `feature:`, etc.) to ensure type detection and correct automation. --- + +## Related Files + +- **[pull-requests.instructions.md](./pull-requests.instructions.md)** — Companion guide for PR creation and labeling; mirrors issue workflow patterns +- **[labeling.instructions.md](./labeling.instructions.md)** — Detailed label naming conventions and one-hot rules +- **[coding-standards.instructions.md](./coding-standards.instructions.md)** — Code quality standards referenced in issue templates + +--- diff --git a/instructions/labeling.instructions.md b/instructions/labeling.instructions.md index df5457f7..a3e3f4f6 100644 --- a/instructions/labeling.instructions.md +++ b/instructions/labeling.instructions.md @@ -1,4 +1,86 @@ --- -applyTo: "**" -description: "Canonical instructions for the unified labeling automation system. Describes mission, strategy, configuration, and best practices for label management across issues, PRs, and discussions." +file_type: "instructions" +title: "Labeling Instructions" +description: "Canonical instructions for the unified labeling automation system. Describes mission, strategy, configuration, and best practices for label management across issues, PRs, and discussions" +scope: "repo-local" +version: "v1.0" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["labels", "automation", "triage", "metadata", "governance"] +applyTo: ["**/*.md", ".github/workflows/labeling.yml", "scripts/agents/labeling.agent.js"] +status: "active" +--- + +# LightSpeed Labeling Instructions + +Unified labeling strategy for organizing and automating GitHub issues, PRs, and discussions. Labels support triage, routing, and workflow automation. + +## Labeling Philosophy + +- **One-hot principle**: Only one value per label group (e.g., one `priority:*`, one `status:*`) +- **Automation-first**: Labels trigger workflows and project updates +- **Discoverability**: Labels enable search and filtering +- **Governance**: Labels enforce quality gates and routing rules + +## Label Categories + +### Status Labels (`status:*`) + +- `status:needs-triage` — New, not yet reviewed +- `status:ready` — Clear requirements, ready to work +- `status:in-progress` — Someone is actively working +- `status:needs-review` — Waiting for review/approval +- `status:blocked` — Blocked by another issue/PR +- `status:done` — Completed and closed + +**Rule:** Each issue/PR has exactly one `status:*` label + +### Priority Labels (`priority:*`) + +- `priority:urgent` — Security, critical bug, or blocker +- `priority:high` — High-impact, affecting multiple users +- `priority:normal` — Standard feature or improvement +- `priority:low` — Nice-to-have, deferred work + +**Rule:** Each issue has exactly one `priority:*` label (PRs inherit from linked issue) + +### Type Labels (`type:*`) + +- `type:bug` — Unexpected behavior or error +- `type:feature` — New functionality +- `type:chore` — Maintenance, cleanup, tooling +- `type:docs` — Documentation improvements +- `type:refactor` — Code quality, no behavior change + +### Area Labels (`area:*`) + +Examples: `area:ci`, `area:documentation`, `area:a11y`, `area:performance` + +Indicates which system or domain the issue affects. + +## Automation Rules + +- Labels trigger workflows via `labeling.agent.js` +- Status changes update project board automatically +- Priority labels route issues to appropriate teams +- Type labels filter by issue category + +## Creating New Labels + +Before creating a label: + +1. Check if an existing label covers the need +2. Propose in an issue with rationale +3. Get approval from governance team +4. Update this documentation +5. Add to `.github/labels.json` + +--- + +## Related Files + +- [issues.instructions.md](./issues.instructions.md) — Issue creation and labeling standards +- [pull-requests.instructions.md](./pull-requests.instructions.md) — PR creation and labeling standards +- [automation.instructions.md](./automation.instructions.md) — Automation and workflow integration + --- diff --git a/instructions/languages.instructions.md b/instructions/languages.instructions.md index af9068cb..52a403fe 100644 --- a/instructions/languages.instructions.md +++ b/instructions/languages.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Programming Languages Standards" description: "Unified linting, formatting, and documentation standards for JavaScript, TypeScript, JSON, and YAML across all GitHub repositories" +scope: "organization-wide" version: "v1.0" last_updated: "2025-12-07" owners: ["GitHub Community Health Team"] @@ -424,3 +425,11 @@ jobs: ``` --- + +## Related Files + +- **[coding-standards.instructions.md](./coding-standards.instructions.md)** — General coding standards applicable across all languages +- **[linting.instructions.md](./linting.instructions.md)** — Tool-specific linting configurations and rules +- **[quality-assurance.instructions.md](./quality-assurance.instructions.md)** — Testing and code quality standards + +--- diff --git a/instructions/linting.instructions.md b/instructions/linting.instructions.md index a8eff4ef..7c3edfa5 100644 --- a/instructions/linting.instructions.md +++ b/instructions/linting.instructions.md @@ -1,6 +1,8 @@ --- file_type: "instructions" +title: "Linting Instructions" description: "Master index for all linting instructions in the LightSpeed organisation. Lists and cross-references all linting instructions, config, and coding standards." +scope: "organization-wide" applyTo: "**/*.{js,ts,php,css,scss,sass,html,json,md,yml,yaml,py,sh}" version: "v2.0" last_updated: "2025-11-27" @@ -185,3 +187,11 @@ Linting instructions should evolve with our standards and requirements. When upd 4. Document significant changes in the commit message. --- + +## Related Files + +- **[coding-standards.instructions.md](./coding-standards.instructions.md)** — General coding standards that linting tools enforce +- **[languages.instructions.md](./languages.instructions.md)** — Language-specific linting configurations and rules +- **[quality-assurance.instructions.md](./quality-assurance.instructions.md)** — Testing standards that complement linting + +--- diff --git a/instructions/mermaid.instructions.md b/instructions/mermaid.instructions.md index 80afb38c..121cdb13 100644 --- a/instructions/mermaid.instructions.md +++ b/instructions/mermaid.instructions.md @@ -1,10 +1,109 @@ --- file_type: "instructions" -title: "Mermaid Diagram Guide" -description: "How to design, style, and validate Mermaid diagrams. For README-specific inclusion rules, see readme.instructions.md." -applyTo: "**/*.md" -last_updated: "2025-12-10" +title: "Mermaid Diagram Instructions" +description: "How to design, create, style, and validate Mermaid diagrams for documentation and architecture visualization" +scope: "repo-local" +version: "v1.0" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["mermaid", "diagrams", "documentation", "a11y", "visuals", "architecture"] +applyTo: ["**/*.md"] status: "active" -owners: ["LightSpeedWP Team"] -tags: ["mermaid", "diagrams", "documentation", "a11y", "visuals"] +--- + +# Mermaid Diagram Instructions + +Use Mermaid diagrams to visualize processes, architectures, and workflows. Create clear, accessible diagrams that enhance documentation. + +## Diagram Types + +### Flowchart + +- Show decision trees and process flows +- Use for workflows and conditionals +- Example: Issue triage process, PR workflow + +### Sequence Diagram + +- Show interactions between systems +- Use for API calls, message flows +- Example: Authentication flow, deployment sequence + +### State Diagram + +- Show state transitions +- Use for status workflows, lifecycle +- Example: Issue status flow, deployment states + +### Gantt Chart + +- Show timelines and dependencies +- Use for release schedules, project planning +- Example: Sprint timeline, milestone calendar + +### Entity Relationship Diagram + +- Show data relationships +- Use for schema documentation +- Example: Database schema, data structures + +## Design Guidelines + +### Simplicity + +- One concept per diagram +- Limit to 5-7 nodes/boxes when possible +- Avoid unnecessary complexity +- Group related elements + +### Clarity + +- Use descriptive labels +- Avoid abbreviations unless standard +- Consistent node naming +- Clear arrow direction + +### Accessibility + +- Text-based, not image-only +- Descriptive alt text below diagram +- High contrast between elements +- Avoid color-only information + +## Styling + +Use Mermaid theme variables for consistency: + +``` +%%{init: {'theme': 'default'}}%% +``` + +Standard colors: + +- Primary actions: Blue +- Warnings: Orange +- Errors: Red +- Success: Green + +## Testing and Validation + +- Test in GitHub markdown preview +- Verify on GitHub Pages (if deployed) +- Check mobile rendering +- Provide text alternative for complex diagrams + +## Best Practices + +- Place caption below diagram with description +- Link to detailed documentation from diagram +- Update diagrams when processes change +- Use consistent naming across diagrams + +--- + +## Related Files + +- [documentation-formats.instructions.md](./documentation-formats.instructions.md) — Markdown and diagram standards +- [readme.instructions.md](./readme.instructions.md) — README structure and diagram placement + --- diff --git a/instructions/meta.instructions.md b/instructions/meta.instructions.md index c098bc6c..48a9bfbc 100644 --- a/instructions/meta.instructions.md +++ b/instructions/meta.instructions.md @@ -1,5 +1,6 @@ --- file_type: "instructions" +scope: "repo-local" title: "Meta Data Automation Instructions" description: "How to use the Meta Agent to apply front matter, badges, and category-specific quirky footers to Markdown docs." version: "v1.1" diff --git a/instructions/metrics.instructions.md b/instructions/metrics.instructions.md index 694b6650..3d7e489b 100644 --- a/instructions/metrics.instructions.md +++ b/instructions/metrics.instructions.md @@ -1,5 +1,6 @@ --- file_type: "instructions" +scope: "repo-local" title: "Metrics Collection & Reporting Instructions" description: "Standards and guidelines for collecting, aggregating, and reporting repository health metrics including issue/PR activity, response times, and project health indicators" version: "v1.0" diff --git a/instructions/multi-platform-skill-manifests.instructions.md b/instructions/multi-platform-skill-manifests.instructions.md index 18228707..8aaa3a62 100644 --- a/instructions/multi-platform-skill-manifests.instructions.md +++ b/instructions/multi-platform-skill-manifests.instructions.md @@ -1,4 +1,7 @@ --- +file_type: "instructions" description: "Rules for authoring and maintaining per-skill platform metadata and agent YAML manifests." +title: "Multi Platform Skill Manifests" +scope: "repo-local" applyTo: "skills/**" --- diff --git a/instructions/planner.instructions.md b/instructions/planner.instructions.md index 0c6fe6a4..d936f08b 100644 --- a/instructions/planner.instructions.md +++ b/instructions/planner.instructions.md @@ -1,5 +1,6 @@ --- file_type: "instructions" +scope: "repo-local" title: "PR Planning & Checklist Instructions" description: "Standards for automated PR checklist generation, merge readiness validation, and planning automation" version: "v1.0" diff --git a/instructions/plugin-structure.instructions.md b/instructions/plugin-structure.instructions.md index a354ef7f..d3354881 100644 --- a/instructions/plugin-structure.instructions.md +++ b/instructions/plugin-structure.instructions.md @@ -1,11 +1,11 @@ --- -title: "WordPress Plugin Structure" +file_type: "instructions" +title: "Plugin Structure Instructions" description: "WordPress block plugin structure conventions for all LightSpeed plugins: directory layout, block.json, asset enqueueing, security, and i18n." -category: "Documentation" +scope: "organization-wide" applyTo: "**" -file_type: "instructions" -version: "v1.1" -last_updated: "2026-05-28" +version: "v1.0" +last_updated: "2026-05-20" owners: ["LightSpeed Team"] tags: ["wordpress", "plugin", "blocks", "block-json", "structure", "php", "i18n"] domain: "plugin-hardening" diff --git a/instructions/project-meta-sync.instructions.md b/instructions/project-meta-sync.instructions.md index 5d665352..dcea6511 100644 --- a/instructions/project-meta-sync.instructions.md +++ b/instructions/project-meta-sync.instructions.md @@ -1,5 +1,6 @@ --- file_type: "instructions" +scope: "repo-local" title: "Project Meta Sync Instructions" description: "Standards for syncing GitHub Project board meta fields (Status, Priority, Type) from issue/PR labels and branch names" version: "v1.0" diff --git a/instructions/prompt.instructions.md b/instructions/prompt.instructions.md index 544d3ead..38efd289 100644 --- a/instructions/prompt.instructions.md +++ b/instructions/prompt.instructions.md @@ -1,4 +1,73 @@ --- -description: "Guidelines for creating high-quality prompt files for GitHub Copilot" -applyTo: "**/*.prompt.md" +file_type: "instructions" +title: "Prompt File Instructions" +description: "Guidelines for creating high-quality prompt files for GitHub Copilot and reusable AI workflows" +scope: "repo-local" +version: "v1.0" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["prompts", "copilot", "ai", "templates", "automation"] +applyTo: ["prompts/**/*.prompt.md", ".github/prompts/**/*.md"] +status: "active" +--- + +# LightSpeed Prompt File Instructions + +Create reusable, well-structured prompt files for GitHub Copilot and AI workflows. Prompts should be modular, context-aware, and aligned with project standards. + +## General Rules + +- Prompt files use `.prompt.md` extension for discoverability +- Follow YAML frontmatter with clear metadata +- Include system role, context, and expected output format +- Use placeholders (`{{variable}}`) for dynamic content +- Keep prompts focused on a single task or workflow +- Document required inputs and expected outputs + +## Frontmatter Fields + +- `title` — Clear, descriptive title of the prompt +- `description` — One-sentence summary +- `version` — Semantic version (v1.0, v1.1, etc.) +- `scope` — "organization-wide" or "repo-local" +- `role` — Primary use case (e.g., "code-review", "documentation") +- `tags` — Searchable keywords +- `inputs` — Required variables and their descriptions +- `outputs` — Expected output format and structure + +## Prompt Structure + +1. **System Role** — Define the Copilot persona and responsibilities +2. **Context** — Provide background and constraints +3. **Task** — Clear, actionable instructions +4. **Output Format** — Expected format (Markdown, JSON, etc.) +5. **Examples** — Optional examples of expected output + +## Variables and Placeholders + +Use double-brace syntax for variables: `{{variable_name}}` + +Common variables: + +- `{{file_path}}` — File being edited +- `{{language}}` — Programming language +- `{{context}}` — User-provided context +- `{{standards}}` — Applicable coding standards + +## Validation + +All prompt files must: + +- Pass Markdown linting +- Have valid YAML frontmatter +- Include description and role fields +- Use consistent formatting + +--- + +## Related Files + +- [custom-instructions.md](../.github/custom-instructions.md) — Main Copilot instructions for this repository +- [prompts/](../.github/prompts/) — Prompt file collection and index + --- diff --git a/instructions/pull-requests.instructions.md b/instructions/pull-requests.instructions.md index 728095c5..8ef05587 100644 --- a/instructions/pull-requests.instructions.md +++ b/instructions/pull-requests.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Pull Request Creation Instructions" description: "Canonical instructions for creating, labeling, and submitting Pull Requests in LightSpeedWP projects. Reference for templates, automation, and labeling strategy." +scope: "organization-wide" version: "1.2" last_updated: "2026-05-28" owners: ["lightspeedwp/maintainers"] @@ -229,3 +230,11 @@ For maintainers and reviewers, reference these [Saved Replies](../.github/SAVED_ - ...and more. --- + +## Related Files + +- **[issues.instructions.md](./issues.instructions.md)** — Companion guide for issue creation and labeling; mirrors PR workflow patterns +- **[labeling.instructions.md](./labeling.instructions.md)** — Detailed label naming conventions and one-hot rules +- **[coding-standards.instructions.md](./coding-standards.instructions.md)** — Code quality standards referenced in PR templates + +--- diff --git a/instructions/quality-assurance.instructions.md b/instructions/quality-assurance.instructions.md index a5ac82d3..89eec6a0 100644 --- a/instructions/quality-assurance.instructions.md +++ b/instructions/quality-assurance.instructions.md @@ -2,6 +2,7 @@ file_type: "instructions" title: "Quality Assurance Standards" description: "Comprehensive testing, validation, and quality assurance standards for all GitHub repository code and automation" +scope: "organization-wide" version: "v1.0" last_updated: "2025-12-07" owners: ["GitHub Community Health Team"] diff --git a/instructions/readme.instructions.md b/instructions/readme.instructions.md index de08170f..380adf23 100644 --- a/instructions/readme.instructions.md +++ b/instructions/readme.instructions.md @@ -1,10 +1,73 @@ --- file_type: "instructions" -title: "README Standards" -description: "Standards for creating and maintaining README files, including required sections, Mermaid usage rules, and consistency expectations." -applyTo: "README.md" -last_updated: "2025-12-10" +title: "README Instructions" +description: "Standards for creating and maintaining README files, including required sections, structure, and accessibility expectations" +scope: "repo-local" +version: "v1.0" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["readme", "documentation", "structure", "onboarding", "a11y"] +applyTo: ["**/README.md", "README.md"] status: "active" -owners: ["lightspeedwp/maintainers"] -tags: ["readme", "documentation", "mermaid", "structure", "a11y"] +--- + +# README Instructions + +README files are the front door to a repository. Create clear, accessible, and comprehensive README files that support onboarding and discoverability. + +## README Structure (Standard Order) + +1. **Title & Description** — What is this repository? +2. **Table of Contents** — Navigation for longer READMEs +3. **Installation/Setup** — How to get started +4. **Usage** — How to use this project +5. **Configuration** — Config options and environment variables +6. **Development** — How to contribute or develop locally +7. **Testing** — How to run tests +8. **Troubleshooting** — Common issues and solutions +9. **Contributing** — Link to CONTRIBUTING.md +10. **License** — License information +11. **Related** — Links to related resources + +## Required Sections + +Every README must include: + +- **Description** — What the project does in 1-2 sentences +- **Quick Start** — Minimal steps to get it running +- **Installation** — Full setup instructions +- **Related Files** — Links to key documentation + +## Writing Guidelines + +- Use clear, simple language +- Write for the first-time user, not experts +- Include code examples where helpful +- Use headings consistently (ATX style: `#`, `##`, `###`) +- Keep paragraphs short (3-4 sentences max) +- Link to detailed docs for in-depth topics + +## Accessibility Requirements + +- Use descriptive heading hierarchy (no skipped levels) +- Alt text for all images +- Sufficient color contrast in code examples +- Avoid color-only information emphasis +- Proper list formatting + +## Diagrams and Visuals + +Use Mermaid diagrams for architecture and workflows: + +- Keep diagrams simple and focused +- Test rendering in GitHub markdown +- Provide text alternatives for complex diagrams + +--- + +## Related Files + +- [documentation-formats.instructions.md](./documentation-formats.instructions.md) — Markdown and frontmatter standards +- [community-standards.instructions.md](./community-standards.instructions.md) — Naming and file placement conventions + --- diff --git a/instructions/release.instructions.md b/instructions/release.instructions.md index 64441fb2..90bfe684 100644 --- a/instructions/release.instructions.md +++ b/instructions/release.instructions.md @@ -1,5 +1,6 @@ --- file_type: "instructions" +scope: "repo-local" title: "Release Management Instructions" description: "Comprehensive standards for release preparation, validation, automation, semantic versioning, changelog management, and GitHub Release publication" version: "v2.0.1" diff --git a/instructions/reporting.instructions.md b/instructions/reporting.instructions.md index a42d8e6e..9a67eccb 100644 --- a/instructions/reporting.instructions.md +++ b/instructions/reporting.instructions.md @@ -1,5 +1,6 @@ --- file_type: "instructions" +scope: "repo-local" title: Reporting Instructions description: Guidelines for generating and storing reports in this repository. version: "1.1" diff --git a/instructions/self-explanatory-code-commenting.instructions.md b/instructions/self-explanatory-code-commenting.instructions.md index c3fcc3c1..d8ca4b28 100644 --- a/instructions/self-explanatory-code-commenting.instructions.md +++ b/instructions/self-explanatory-code-commenting.instructions.md @@ -1,4 +1,7 @@ --- +file_type: "instructions" description: "Guidelines for GitHub Copilot to write comments to achieve self-explanatory code with less comments. Examples are in JavaScript but it should work on any language that has comments." +title: "Self Explanatory Code Commenting" +scope: "repo-local" applyTo: "**" --- diff --git a/instructions/spec-driven-workflow.instructions.md b/instructions/spec-driven-workflow.instructions.md index cc0afa4f..41b44821 100644 --- a/instructions/spec-driven-workflow.instructions.md +++ b/instructions/spec-driven-workflow.instructions.md @@ -1,4 +1,7 @@ --- +file_type: "instructions" description: "Specification-Driven Workflow v1 provides a structured approach to software development, ensuring that requirements are clearly defined, designs are meticulously planned, and implementations are thoroughly documented and validated." +title: "Spec Driven Workflow" +scope: "repo-local" applyTo: "**" --- diff --git a/instructions/task-implementation.instructions.md b/instructions/task-implementation.instructions.md index 7cbf2046..2ddbf702 100644 --- a/instructions/task-implementation.instructions.md +++ b/instructions/task-implementation.instructions.md @@ -1,4 +1,7 @@ --- applyTo: "**/.copilot-tracking/changes/*.md" +file_type: "instructions" description: "Instructions for implementing task plans with progressive tracking and change record - Brought to you by microsoft/edge-ai" +title: "Task Implementation" +scope: "repo-local" --- diff --git a/instructions/tasksync.instructions.md b/instructions/tasksync.instructions.md index 90c896b6..9ef2ece0 100644 --- a/instructions/tasksync.instructions.md +++ b/instructions/tasksync.instructions.md @@ -1,6 +1,9 @@ --- applyTo: "**" +file_type: "instructions" description: "TaskSync V4 - Allows you to give the agent new instructions or feedback after completing a task using terminal while agent is running." +title: "Tasksync" +scope: "repo-local" --- # TaskSync V4 Protocol diff --git a/instructions/template.instructions.md b/instructions/template.instructions.md index 55835fa3..d0bd18d1 100644 --- a/instructions/template.instructions.md +++ b/instructions/template.instructions.md @@ -1,13 +1,80 @@ --- file_type: "instructions" -title: "Template: Instructions" -description: "Generic instruction file skeleton for LightSpeedWP documentation and automation." +title: "Instruction File Template" +description: "Generic instruction file skeleton and best practices for creating LightSpeedWP instruction files" +scope: "repo-local" version: "v1.0" -last_updated: "2025-10-23" -owners: ["LightSpeedWP Engineering"] -tags: ["template", "instructions", "copilot", "guidance"] -status: "draft" -applyTo: ["**/*.instructions.md"] -examples: - - "coding-standards.instructions.md" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["template", "instructions", "copilot", "guidance", "authoring"] +applyTo: ["instructions/*.instructions.md"] +status: "active" +--- + +# Instruction File Template + +Use this template when creating new instruction files. Instruction files guide AI assistants and developers on LightSpeed standards and workflows. + +## When to Create an Instruction File + +Create an instruction file when you need to: + +- Document repeatable guidance or standards +- Provide context-specific rules for AI assistants +- Establish governance or best practices +- Create organization-wide or repo-local standards + +## Frontmatter Requirements + +All instruction files must include: + +```yaml +--- +file_type: "instructions" +title: "Descriptive Title" +description: "One-sentence summary" +scope: "organization-wide" or "repo-local" +version: "v1.0" +last_updated: "YYYY-MM-DD" +owners: ["Team Name"] +tags: ["keyword1", "keyword2"] +applyTo: ["path/pattern/**"] +status: "active" or "draft" +--- +``` + +## File Structure + +1. **Title** (H1) — Same as frontmatter title +2. **Introductory sentence** — What this file teaches +3. **Overview** — High-level context and scope +4. **General Rules** — Foundational principles +5. **Detailed Guidance** — Section-by-section instructions +6. **Examples** — Realistic examples +7. **Related Files** — Cross-links to other instruction files +8. **Changelog** (Optional) — Version history for major files + +## Writing Guidelines + +- Use UK English spelling (organisation, optimise, colour) +- Write in active voice +- Keep sentences concise +- Use bullet points for lists +- Include examples and counter-examples +- Link to related files and standards +- Avoid assumptions about reader knowledge + +## Scope Classification + +- **organization-wide**: Applicable to all LightSpeedWP projects; portable across repos +- **repo-local**: Specific to this `.github` control plane or single repository + +--- + +## Related Files + +- [instructions.instructions.md](./instructions.instructions.md) — Detailed authoring guidance +- [documentation-formats.instructions.md](./documentation-formats.instructions.md) — Markdown and frontmatter standards +- [coding-standards.instructions.md](./coding-standards.instructions.md) — Code examples and conventions + --- diff --git a/instructions/tools.instructions.md b/instructions/tools.instructions.md index 4249e2d3..a8e7cd1b 100644 --- a/instructions/tools.instructions.md +++ b/instructions/tools.instructions.md @@ -1,9 +1,69 @@ --- file_type: "instructions" -title: "Tool Configuration Documentation Template" -description: "Standard format for documenting configuration files under docs/config" -last_updated: "2025-11-12" -version: "1.0" -maintainers: ["LightSpeed Team"] -tags: ["documentation", "configuration", "standards"] +title: "Tools and Configuration Instructions" +description: "Standard format for documenting tool configurations, dependencies, and integration patterns" +scope: "repo-local" +version: "v1.0" +last_updated: "2026-05-29" +owners: ["LightSpeed Team"] +tags: ["tools", "configuration", "documentation", "setup", "automation"] +applyTo: ["docs/config/**/*.md", "docs/tools/**/*.md"] +status: "active" +--- + +# Tool Configuration and Documentation Instructions + +Document tools, configurations, and integrations for maintainability and onboarding. Each tool should have clear setup instructions and configuration options. + +## Tool Documentation Structure + +### Frontmatter + +- `title` — Tool name and purpose +- `description` — One-sentence summary +- `version` — Latest version or version range +- `scope` — Where tool is used + +### Content Sections + +1. **Overview** — What the tool does and why it's used +2. **Installation** — How to install or enable +3. **Configuration** — Config files and key options +4. **Usage** — Common commands or workflows +5. **Troubleshooting** — Common issues and solutions +6. **Related Tools** — Other tools that integrate or complement + +## Configuration File Documentation + +For tools with config files (`.eslintrc.json`, `prettier.config.js`, etc.): + +1. **Config Location** — Where file lives in repo +2. **Current Values** — Documented purpose of each setting +3. **Defaults vs. Custom** — What we override and why +4. **Updates** — How to safely modify configuration +5. **Validation** — How to test configuration changes + +## Best Practices + +- Keep documentation current with actual tool versions +- Include links to official documentation +- Provide examples of common configurations +- Document environment variables and secrets (without exposing values) +- Include troubleshooting section +- Link to related tools and workflows + +## Configuration Standards + +- One tool = one documentation file +- Name file after tool or config (e.g., `eslint.md`, `prettier.md`) +- Use code blocks for configuration examples +- Keep security-sensitive values out of documentation + +--- + +## Related Files + +- [automation.instructions.md](./automation.instructions.md) — Tool automation and workflow integration +- [coding-standards.instructions.md](./coding-standards.instructions.md) — Standards that tools enforce + --- diff --git a/instructions/wordpress-project-planning.instructions.md b/instructions/wordpress-project-planning.instructions.md index 9a99549c..cc9e196a 100644 --- a/instructions/wordpress-project-planning.instructions.md +++ b/instructions/wordpress-project-planning.instructions.md @@ -1,4 +1,7 @@ --- +file_type: "instructions" description: "Standards for planning WordPress project work from intake to implementation-ready task sequencing." +title: "Wordpress Project Planning" +scope: "repo-local" applyTo: "**/*.md" --- diff --git a/instructions/workflows.instructions.md b/instructions/workflows.instructions.md index c7e29659..ba2273e4 100644 --- a/instructions/workflows.instructions.md +++ b/instructions/workflows.instructions.md @@ -1,6 +1,8 @@ --- file_type: "instructions" applyTo: [".github/workflows/**/*.yml", ".github/workflows/**/*.yaml"] +title: "Workflows" +scope: "repo-local" description: "Write secure, cache-efficient, reusable workflows with tests." last_updated: "2025-12-04" version: "v1.0"