Skip to content

Commit a9ee32d

Browse files
committed
Update instruction files
1 parent 2f5f40c commit a9ee32d

31 files changed

+645
-653
lines changed
File renamed without changes.

.github/instructions/_index.instructions.md

Lines changed: 386 additions & 0 deletions
Large diffs are not rendered by default.

.github/instructions/a11y.instructions.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ Applies to all code, content, and UI you generate. Covers WCAG 2.2 AA alignment,
2828

2929
### Bias Awareness - Inclusive Language
3030

31-
## Bias Awareness - Inclusive Language
32-
3331
In addition to producing accessible code, GitHub Copilot and similar tools must also demonstrate respectful and bias-aware behavior in accessibility contexts. All generated output must follow these principles:
3432

3533
- **Respectful, Inclusive Language**
@@ -131,6 +129,8 @@ When using roving tabindex to manage focus in a composite component, the element
131129
- If a background color is not set or is fully transparent, then the contrast ratio is calculated against the background color of the parent element.
132130
- Parts of graphics required to understand the graphic must have at least a 3:1 contrast with adjacent colors.
133131
- Parts of controls needed to identify the type of control must have at least a 3:1 contrast with adjacent colors.
132+
- Parts of controls needed to communicate state (pressed, focus, checked, etc.) must have at least a 3:1 contrast with adjacent colors.
133+
- Do not rely on colour alone to convey information; pair colour with text, iconography, or shapes.
134134

135135
## Examples
136136

@@ -143,14 +143,6 @@ When using roving tabindex to manage focus in a composite component, the element
143143
- Manually test keyboard navigation (Tab, Shift+Tab, Enter, Escape, Arrow keys) and focus visibility.
144144
- Verify colour contrast meets WCAG 2.2 AA for text and controls.
145145

146-
## References
147-
148-
- `.github/instructions/instructions.instructions.md`
149-
- `.github/instructions/mermaid.instructions.md` (for diagram a11y)
150-
- `.github/instructions/documentation-formats.instructions.md`
151-
- Parts of controls needed to identify the state of the control (pressed, focus, checked, etc.) must have at least a 3:1 contrast with adjacent colors.
152-
- Color must not be used as the only way to convey information. E.g., a red border to convey an error state, color coding information, etc. Use text and/or shapes in addition to color to convey information.
153-
154146
### Screen reader instructions
155147

156148
- All elements must correctly convey their semantics, such as name, role, value, states, and/or properties. Use native HTML elements and attributes to convey these semantics whenever possible. Otherwise, use appropriate ARIA attributes.
@@ -497,3 +489,10 @@ Tables should be used for static information that is best represented in a tabul
497489
#### Use grids for dynamic information
498490

499491
Grids should be used for dynamic information that is best represented in a grid format. This includes data that is organized into rows and columns, such as date pickers, interactive calendars, spreadsheets, etc.
492+
493+
## References
494+
495+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
496+
- [documentation-formats.instructions.md](.github/instructions/documentation-formats.instructions.md)
497+
- [mermaid.instructions.md](.github/instructions/mermaid.instructions.md)
498+
- [WCAG 2.2 AA](https://www.w3.org/TR/WCAG22/)

.github/instructions/agent-spec.instructions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,10 @@ metadata:
133133

134134
## References
135135

136-
- `AGENTS.md`
137-
- `.github/agents/template.agent.md`
138-
- `.github/instructions/instructions.instructions.md`
139-
- `.github/instructions/automation.instructions.md`
140-
- `.github/instructions/documentation-formats.instructions.md`
141-
- `.github/instructions/quality-assurance.instructions.md`
142-
- `SECURITY.md`
136+
- [AGENTS.md](AGENTS.md)
137+
- [template.agent.md](.github/agents/template.agent.md)
138+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
139+
- [automation.instructions.md](.github/instructions/automation.instructions.md)
140+
- [documentation-formats.instructions.md](.github/instructions/documentation-formats.instructions.md)
141+
- [quality-assurance.instructions.md](.github/instructions/quality-assurance.instructions.md)
142+
- [SECURITY.md](SECURITY.md)

.github/instructions/automation.instructions.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -63,16 +63,6 @@ Ensure consistent, reliable, and maintainable automation across GitHub repositor
6363
- Validate workflows with `actionlint` and ensure actions are pinned to SHAs.
6464
- Check labeler/labels/issue-types YAML against schemas where provided.
6565

66-
## References
67-
68-
- `.github/instructions/instructions.instructions.md`
69-
- `.github/instructions/workflows.instructions.md`
70-
- `.github/instructions/labeling.instructions.md`
71-
- `.github/instructions/file-organisation.instructions.md`
72-
- `.github/agents/agent.md`
73-
74-
---
75-
7666
## Automation Architecture
7767

7868
### System Overview
@@ -179,7 +169,7 @@ What this agent does and why it exists.
179169
- Validation requirements
180170
- Failure handling
181171

182-
## References
172+
## Template References
183173

184174
- Related workflows
185175
- Documentation
@@ -774,21 +764,15 @@ echo $?
774764

775765
## References
776766

777-
### Documentation
778-
779-
- [GitHub Actions](https://docs.github.com/en/actions)
767+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
768+
- [workflows.instructions.md](.github/instructions/workflows.instructions.md)
769+
- [labeling.instructions.md](.github/instructions/labeling.instructions.md)
770+
- [pull-requests.instructions.md](.github/instructions/pull-requests.instructions.md)
771+
- [issues.instructions.md](.github/instructions/issues.instructions.md)
772+
- [quality-assurance.instructions.md](.github/instructions/quality-assurance.instructions.md)
773+
- [file-organisation.instructions.md](.github/instructions/file-organisation.instructions.md)
774+
- [agent.md](.github/agents/agent.md)
775+
- [GitHub Actions Documentation](https://docs.github.com/en/actions)
780776
- [GitHub API](https://docs.github.com/en/rest)
781777
- [Semantic Versioning](https://semver.org/)
782778
- [Keep a Changelog](https://keepachangelog.com/)
783-
784-
### Related Instructions
785-
786-
- [Workflows](./workflows.instructions.md)
787-
- [Labeling](./labeling.instructions.md)
788-
- [Pull Requests](./pull-requests.instructions.md)
789-
- [Issues](./issues.instructions.md)
790-
- [Quality Assurance](./quality-assurance.instructions.md)
791-
792-
---
793-
794-
*This document consolidates automation standards for GitHub community health repositories. All automation must follow these standards for consistency and reliability.*

.github/instructions/coding-standards.instructions.md

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,6 @@ Applies to all code, documentation, automation, and AI-generated content across
4242
- Validate links in docs and ensure accessibility standards are met.
4343
- Confirm AI outputs adhere to this file and project-specific instructions.
4444

45-
## References
46-
47-
- `.github/instructions/linting.instructions.md`
48-
- `.github/instructions/documentation-formats.instructions.md`
49-
- `.github/instructions/a11y.instructions.md`
50-
- `.github/instructions/instructions.instructions.md`
51-
5245
This document is the single source of truth for all coding standards in LightSpeedWP projects. It applies to **all code, docs, automation, and AI-generated content**.
5346

5447
---
@@ -60,7 +53,7 @@ This document is the single source of truth for all coding standards in LightSpe
6053
- [Formatting & Automation](#formatting--automation)
6154
- [Documentation Standards](#documentation-standards)
6255
- [AI & Copilot Instructions](#ai--copilot-instructions)
63-
- [References & Related Guidance](#references--related-guidance)
56+
- [References](#references)
6457

6558
---
6659

@@ -77,19 +70,19 @@ This document is the single source of truth for all coding standards in LightSpe
7770
## Language-Specific Standards
7871

7972
- **JavaScript/TypeScript:**
80-
- Lint with ESLint (flat/classic), Prettier.
81-
- Reference: [`linting-javascript.instructions.md`](./linting-javascript.instructions.md)
73+
- Lint with ESLint (flat/classic) and Prettier.
74+
- Reference: [`languages.instructions.md`](./languages.instructions.md)
8275

8376
- **JSON:**
84-
- Enforce strict schemas and formatting with Prettier, (optionally) AJV.
85-
- Reference: [`linting-json.instructions.md`](./linting-json.instructions.md)
77+
- Enforce strict schemas and formatting with Prettier and, where required, AJV.
78+
- Reference: [`languages.instructions.md`](./languages.instructions.md)
8679

8780
- **Markdown:**
88-
- Use markdownlint + Prettier.
89-
- Reference: [`linting-markdown.instructions.md`](./linting-markdown.instructions.md)
81+
- Use markdownlint and Prettier.
82+
- Reference: [`documentation-formats.instructions.md`](./documentation-formats.instructions.md)
9083
- **YAML:**
91-
- Use yamllint, Spectral, actionlint for workflows.
92-
- Reference: [`linting-yaml.instructions.md`](./linting-yaml.instructions.md)
84+
- Use yamllint, Spectral, and actionlint for workflows.
85+
- Reference: [`languages.instructions.md`](./languages.instructions.md) and [`workflows.instructions.md`](./workflows.instructions.md)
9386

9487
---
9588

@@ -115,14 +108,15 @@ All documentation links to files within the same repository should use `/blob/HE
115108

116109
---
117110

118-
## References & Related Guidance
119-
120-
- [LightSpeed Custom Instructions](../custom-instructions.md)
121-
- [LightSpeed Copilot Prompts Index](../prompts/prompts.md)
122-
- [LightSpeed Agents Index](../agents/agent.md)
123-
- [LightSpeed GitHub Workflow Governance](../docs/WORKFLOWS.md)
124-
125-
---
111+
## References
126112

127-
*This file is the canonical reference for all code, documentation, and automation standards in LightSpeedWP projects.
128-
All contributors, agents, and AI assistants must comply with these standards.*
113+
- [linting.instructions.md](.github/instructions/linting.instructions.md)
114+
- [documentation-formats.instructions.md](.github/instructions/documentation-formats.instructions.md)
115+
- [languages.instructions.md](.github/instructions/languages.instructions.md)
116+
- [a11y.instructions.md](.github/instructions/a11y.instructions.md)
117+
- [workflows.instructions.md](.github/instructions/workflows.instructions.md)
118+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
119+
- [LightSpeed Custom Instructions](.github/custom-instructions.md)
120+
- [LightSpeed Copilot Prompts Index](.github/prompts/prompts.md)
121+
- [LightSpeed Agents Index](.github/agents/agent.md)
122+
- [LightSpeed GitHub Workflow Governance](docs/WORKFLOWS.md)

.github/instructions/community-standards.instructions.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ How to use or interact with contents.
358358
├── file2.js - Description
359359
└── folder/ - Description
360360

361-
## References
361+
## Template References
362362

363363
- [Link to related docs]
364364
- [Link to instructions]
@@ -434,7 +434,7 @@ What this folder contains and why.
434434
435435
How to use files in this folder.
436436
437-
## References
437+
## Template References
438438
439439
- [Related documentation]
440440
````
@@ -683,30 +683,24 @@ build/
683683
coverage/
684684
```
685685

686+
687+
*This document consolidates community health standards for GitHub repositories. All files and documentation must follow these standards for consistency and professionalism.*
688+
686689
---
687690

688691
## References
689692

690-
### GitHub Documentation
691-
693+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
694+
- [file-organisation.instructions.md](.github/instructions/file-organisation.instructions.md)
695+
- [documentation-formats.instructions.md](.github/instructions/documentation-formats.instructions.md)
696+
- [readme.instructions.md](.github/instructions/readme.instructions.md)
697+
- [automation.instructions.md](.github/instructions/automation.instructions.md)
698+
- [workflows.instructions.md](.github/instructions/workflows.instructions.md)
699+
- [issues.instructions.md](.github/instructions/issues.instructions.md)
700+
- [pull-requests.instructions.md](.github/instructions/pull-requests.instructions.md)
692701
- [Community Health Files](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions)
693702
- [About READMEs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)
694703
- [Saved Replies](https://docs.github.com/en/get-started/writing-on-github/working-with-saved-replies/using-saved-replies)
695-
696-
### Best Practices
697-
698704
- [README Best Practices](https://www.makeareadme.com/)
699705
- [Open Source Guides](https://opensource.guide/)
700706
- [Conventional Commits](https://www.conventionalcommits.org/)
701-
702-
### Related Instructions
703-
704-
- [Documentation Formats](./documentation-formats.instructions.md)
705-
- [Automation](./automation.instructions.md)
706-
- [Workflows](./workflows.instructions.md)
707-
- [Issues](./issues.instructions.md)
708-
- [Pull Requests](./pull-requests.instructions.md)
709-
710-
---
711-
712-
*This document consolidates community health standards for GitHub repositories. All files and documentation must follow these standards for consistency and professionalism.*

.github/instructions/copilot-operations.instructions.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,6 @@ Applies to all Copilot/agent work in this repository. Covers behaviour guardrail
6262

6363
## References
6464

65-
- `.github/instructions/instructions.instructions.md`
66-
- `.github/instructions/file-organisation.instructions.md`
67-
- `.github/instructions/coding-standards.instructions.md`
68-
69-
---
65+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
66+
- [file-organisation.instructions.md](.github/instructions/file-organisation.instructions.md)
67+
- [coding-standards.instructions.md](.github/instructions/coding-standards.instructions.md)

.github/instructions/docs.instructions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,6 @@ Every documentation file should start with YAML frontmatter including:
130130
- Validate links and frontmatter references after edits.
131131
- Use accessibility checks for headings, contrast (if styled), and alt text.
132132

133-
## References
134-
135-
- `.github/instructions/instructions.instructions.md`
136-
- `.github/instructions/readme.instructions.md`
137-
- `.github/instructions/a11y.instructions.md`
138-
- `.github/instructions/documentation-formats.instructions.md`
139-
140133
### Documentation Checklist
141134

142135
- [ ] YAML frontmatter is present and complete
@@ -153,3 +146,10 @@ Every documentation file should start with YAML frontmatter including:
153146
- [ ] Contribution and review process described
154147
- [ ] Compliance/security info present if needed
155148
- [ ] Footer is present and complete
149+
150+
## References
151+
152+
- [instructions.instructions.md](./instructions.instructions.md)
153+
- [readme.instructions.md](./readme.instructions.md)
154+
- [a11y.instructions.md](./a11y.instructions.md)
155+
- [documentation-formats.instructions.md](./documentation-formats.instructions.md)

.github/instructions/documentation-formats.instructions.md

Lines changed: 5 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,6 @@ Applies to Markdown files across the repository. Covers formatting rules, frontm
4444
- Validate frontmatter against repo schemas where applicable.
4545
- Use Mermaid preview/render checks and contrast verification for diagrams.
4646

47-
## References
48-
49-
- `.github/instructions/readme.instructions.md`
50-
- `.github/instructions/a11y.instructions.md`
51-
- `.github/instructions/instructions.instructions.md`
52-
53-
This document consolidates standards for Markdown formatting, YAML frontmatter metadata, and Mermaid diagram implementation across all GitHub repository documentation and community health files.
54-
55-
## Purpose
56-
57-
Ensure consistent, accessible, and well-structured documentation that supports automation, discoverability, and maintainability across GitHub repositories.
58-
59-
---
60-
6147
## Table of Contents
6248

6349
- [Markdown Standards](#markdown-standards)
@@ -594,33 +580,19 @@ jobs:
594580
595581
## References
596582
597-
### Markdown
598-
583+
- [instructions.instructions.md](.github/instructions/instructions.instructions.md)
584+
- [readme.instructions.md](.github/instructions/readme.instructions.md)
585+
- [a11y.instructions.md](.github/instructions/a11y.instructions.md)
586+
- [languages.instructions.md](.github/instructions/languages.instructions.md)
587+
- [linting.instructions.md](.github/instructions/linting.instructions.md)
599588
- [markdownlint Documentation](https://github.com/DavidAnson/markdownlint)
600589
- [Prettier Markdown Support](https://prettier.io/docs/en/options.html#prose-wrap)
601590
- [GitHub Flavored Markdown](https://github.github.com/gfm/)
602591
- [CommonMark Specification](https://commonmark.org/)
603-
604-
### YAML Frontmatter
605-
606592
- [YAML Specification](https://yaml.org/spec/)
607593
- [JSON Schema](https://json-schema.org/)
608594
- [GitHub Issue Templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests)
609-
610-
### Mermaid
611-
612595
- [Mermaid Documentation](https://mermaid.js.org/)
613596
- [GitHub Mermaid Support](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/)
614597
- [Mermaid Live Editor](https://mermaid.live)
615598
- [W3C Complex Images](https://www.w3.org/WAI/tutorials/images/complex/)
616-
617-
### Related Instructions
618-
619-
- [Coding Standards](./coding-standards.instructions.md)
620-
- [Languages Standards](./languages.instructions.md)
621-
- [Accessibility Standards](./a11y.instructions.md)
622-
- [Linting Standards](./linting.instructions.md)
623-
624-
---
625-
626-
*This document consolidates documentation format standards for GitHub community health repositories. All documentation must follow these standards for consistency, accessibility, and automation compatibility.*

0 commit comments

Comments
 (0)