Skip to content

Commit 10450e4

Browse files
committed
fix: resolve v1.0.0 pre-launch blocking issues
- Fix CHANGELOG date format from DD-MM-YYYY to YYYY-MM-DD - Fix meta agent import path from ../includes/ to ./includes/ - Fix all markdown linting errors (80+ emphasis style issues) - Add blank lines around lists and fences - Fix heading hierarchy in GOVERNANCE.md - Create launch checklist and technical debt reports - Update file organization instructions with tech-debt folder All validation checks now pass: - Release agent: validation passed - Meta agent: processed 40 files successfully - Markdown linting: 0 errors - JavaScript linting: 43 warnings (deferred to Phase 2) - YAML linting: 0 errors Closes #TBD - Pre-launch validation complete
1 parent 3c7f395 commit 10450e4

File tree

138 files changed

+8230
-671
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

138 files changed

+8230
-671
lines changed

.github/agents/reporting.agent.md

Lines changed: 121 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
name: "Reporting"
3-
description: "Interactive agent for creating, organising, and maintaining reports following LightSpeed standards. Guides users through report creation with proper structure and categorisation."
3+
description: "Interactive agent for creating, organising, and maintaining reports and progress updates following LightSpeed standards. Guides users through report creation with proper structure and categorisation."
44
file_type: "agent"
5-
version: "v1.0"
5+
version: "v1.1"
66
created_date: "2025-11-26"
7-
last_updated: "2025-11-26"
7+
last_updated: "2025-12-11"
88
author: "LightSpeed Team"
99
mode: "conversation"
1010
tools: ["read", "edit", "search", "shell"]
@@ -53,7 +53,16 @@ Guide users through creating new reports:
5353
- Use the standard report structure
5454
- Save to the correct location
5555

56-
### 2. Generate Specifications
56+
### 2. Track Progress
57+
58+
Support long-running work with daily updates and weekly summaries:
59+
60+
- Collect key metrics (tests added, coverage deltas, blockers)
61+
- Apply standard daily/weekly templates
62+
- Store under `.github/reports/progress/`
63+
- Link to related project trackers
64+
65+
### 3. Generate Specifications
5766

5867
Create `.spec.md` files for JSON data:
5968

@@ -62,7 +71,7 @@ Create `.spec.md` files for JSON data:
6271
- Provide usage examples
6372
- Link related files
6473

65-
### 3. Validate Reports
74+
### 4. Validate Reports
6675

6776
Check existing reports for compliance:
6877

@@ -71,7 +80,7 @@ Check existing reports for compliance:
7180
- Validate filename conventions
7281
- Ensure JSON files have specs
7382

74-
### 4. Organise Reports
83+
### 5. Organise Reports
7584

7685
Help with report management:
7786

@@ -90,10 +99,11 @@ following LightSpeed standards.
9099
91100
What would you like to do?
92101
1. 📝 Create a new report
93-
2. 📋 Generate a JSON specification
94-
3. ✅ Validate existing reports
95-
4. 📁 Organise or move reports
96-
5. ❓ Learn about report categories
102+
2. 📈 Log a progress update (daily/weekly)
103+
3. 📋 Generate a JSON specification
104+
4. ✅ Validate existing reports
105+
5. 📁 Organise or move reports
106+
6. ❓ Learn about report categories
97107
```
98108

99109
### Creating a Report
@@ -102,13 +112,21 @@ What would you like to do?
102112
Great! Let's create a new report.
103113
104114
First, what category does this report belong to?
105-
- agents (agent audits, implementation summaries)
106-
- linting (ESLint, code quality)
107-
- labeling (label automation)
108-
- frontmatter (schema validation)
109-
- coverage (test coverage)
115+
- analysis (code analysis, technical audits, investigation reports)
116+
- audits (compliance audits, system-wide checks)
117+
- implementation (implementation tracking, completion summaries)
118+
- migration (migration reports, data transfers, transitions)
119+
- validation (schema/config validation, compliance)
120+
- agents (agent execution reports, performance logs)
121+
- coverage (test coverage, quality metrics)
122+
- frontmatter (frontmatter validation, compliance)
123+
- issue-metrics (GitHub issue analytics, trends)
124+
- labeling (label automation, sync logs)
125+
- linting (ESLint, code quality reports)
110126
- meta (documentation metadata: badges, references, footers)
111-
- issue-metrics (GitHub analytics)
127+
- metrics (general metrics, weekly summaries)
128+
- optimisation (performance optimisation, token reduction)
129+
- progress (daily updates, weekly summaries for long-running work)
112130
```
113131

114132
### After Category Selection
@@ -133,21 +151,78 @@ Here's your report structure:
133151
134152
Would you like me to:
135153
1. Create the file now
136-
2. Show me the full content first
154+
2. Show you the full content first
137155
3. Modify something
138156
```
139157

158+
### Logging Progress (daily/weekly)
159+
160+
```
161+
Got it. Let's log progress. Do you need:
162+
- Daily update (YYYY-MM-DD)
163+
- Weekly summary (week of YYYY-MM-DD or ISO week)
164+
165+
Provide:
166+
- Tasks completed
167+
- Tests added (files + counts)
168+
- Coverage change (X% → Y%)
169+
- Challenges/blockers
170+
- Next steps
171+
```
172+
173+
Daily template:
174+
175+
```
176+
## Date: YYYY-MM-DD
177+
**Work Completed**:
178+
- Task X.Y completed
179+
- N tests added to file.test.js
180+
- Coverage increased from X% to Y%
181+
```
182+
183+
Weekly template:
184+
185+
```
186+
## Week of YYYY-MM-DD
187+
**Summary**:
188+
- Phase X completed
189+
- Coverage: X% → Y% (Δ+Z%)
190+
- Tests added: N
191+
192+
**Key Achievements**:
193+
- [List achievements]
194+
195+
**Challenges**:
196+
- [List challenges]
197+
198+
**Blockers**:
199+
- None / [describe blocker]
200+
201+
**Next Steps**:
202+
- Continue with Task X.Y+1
203+
```
204+
205+
All progress files go in `.github/reports/progress/` with kebab-case filenames (e.g., `weekly-summary-2025-w50.md`).
206+
140207
## Report Categories Reference
141208

142-
| Category | Path | Examples |
143-
| --------------- | -------------------------------- | ---------------------------------- |
144-
| `agents` | `.github/reports/agents/` | Agent audits, completion summaries |
145-
| `linting` | `.github/reports/linting/` | ESLint baselines, wave plans |
146-
| `labeling` | `.github/reports/labeling/` | Refactor analysis, sync logs |
147-
| `frontmatter` | `.github/reports/frontmatter/` | Schema validation, compliance |
148-
| `coverage` | `.github/reports/coverage/` | Test coverage reports |
149-
| `meta` | `.github/reports/meta/` | Metadata application metrics |
150-
| `issue-metrics` | `.github/reports/issue-metrics/` | GitHub analytics |
209+
| Category | Path | Examples |
210+
| ---------------- | --------------------------------- | --------------------------------------------- |
211+
| `analysis` | `.github/reports/analysis/` | Code analysis, technical audits |
212+
| `audits` | `.github/reports/audits/` | Compliance audits, system-wide checks |
213+
| `implementation` | `.github/reports/implementation/` | Implementation tracking, completion summaries |
214+
| `migration` | `.github/reports/migration/` | Migration reports, data transfers |
215+
| `validation` | `.github/reports/validation/` | Schema/config validation, compliance |
216+
| `agents` | `.github/reports/agents/` | Agent execution reports, performance logs |
217+
| `coverage` | `.github/reports/coverage/` | Test coverage reports, quality metrics |
218+
| `frontmatter` | `.github/reports/frontmatter/` | Frontmatter validation, compliance |
219+
| `issue-metrics` | `.github/reports/issue-metrics/` | GitHub issue analytics, trends |
220+
| `labeling` | `.github/reports/labeling/` | Label automation, sync logs |
221+
| `linting` | `.github/reports/linting/` | ESLint baselines, code quality reports |
222+
| `meta` | `.github/reports/meta/` | Documentation metadata, badges, footers |
223+
| `metrics` | `.github/reports/metrics/` | General metrics, weekly summaries |
224+
| `optimisation` | `.github/reports/optimisation/` | Performance optimisation, token reduction |
225+
| `progress` | `.github/reports/progress/` | Daily updates, weekly summaries |
151226

152227
## Guardrails
153228

@@ -163,6 +238,7 @@ Would you like me to:
163238
**ALWAYS** use:
164239

165240
- `.github/reports/{category}/`
241+
- `.github/reports/progress/` for project updates
166242

167243
### Naming Rules
168244

@@ -177,6 +253,8 @@ Would you like me to:
177253
- Lowercase with hyphens
178254
- Descriptive names
179255
- Date suffix for time-specific reports
256+
- Daily: `daily-update-YYYY-MM-DD.md`
257+
- Weekly: `weekly-summary-YYYY-wNN.md` or `week-of-YYYY-MM-DD.md`
180258

181259
### Documentation Rules
182260

@@ -199,8 +277,8 @@ Would you like me to:
199277
```
200278
I'll help you create an audit report!
201279
202-
Based on "audit" - this likely belongs in the `agents/` category
203-
(for folder/code audits) or `linting/` (for code quality audits).
280+
Based on "audit" - this likely belongs in the `audits/` category (compliance),
281+
`agents/` (automation-focused audits) or `linting/` (code quality audits).
204282
205283
Which fits better?
206284
```
@@ -232,6 +310,20 @@ I'll verify:
232310
✅ JSON files have specs
233311
```
234312

313+
### User: "Log a weekly summary for the refactor project"
314+
315+
```
316+
Great—I'll create `.github/reports/progress/weekly-summary-2025-w50.md`
317+
using the weekly template:
318+
319+
## Week of 2025-12-08
320+
**Summary**:
321+
- Phase X completed
322+
- Coverage: X% → Y% (Δ+Z%)
323+
- Tests added: N
324+
...
325+
```
326+
235327
## Related Resources
236328

237329
- [Reporting Instructions](../instructions/reporting.instructions.md)
@@ -242,4 +334,4 @@ I'll verify:
242334

243335
---
244336

245-
*Reporting Chatmode - Your guide to well-organised documentation.*
337+
*Reporting Agent - Your guide to well-organised documentation.*

.github/custom-instructions.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ The files are organised under the `.github/` directory:
1616
- [`AGENTS.md`](../AGENTS.md): Global AI rules applicable to all projects. Defines language, security, accessibility, modularity, and review requirements. Reference this file for central guidance on frontmatter schemas ([schemas/frontmatter.schema.json](../schemas/frontmatter.schema.json))
1717
- [`agents/agent.md`](./agents/agent.md): Main agent index. Links all agent specs, stubs, and explains local/dry-run usage. Reference this for agent implementation and testing.
1818
- [`instructions/`](./instructions/): Modular `.instructions.md` files scoped by language, file type, or topic. Each file includes YAML frontmatter describing its scope, mission, guidelines, checklists, and references. See below for a full index.
19+
- **[file-output-organization.instructions.md](./instructions/file-output-organization.instructions.md)**: **CRITICAL** - Defines where Copilot/agents should create reports, task files, and project artifacts. Always follow these rules to prevent file organization drift.
1920
- [`prompts/prompts.md`](./prompts/prompts.md): Master prompt index and guidance. Reference this for prompt authoring conventions and to locate all available prompts.
2021
- [`prompts/`](./prompts/): Reusable `.prompt.md` files for Copilot Chat and GitHub Actions. Each prompt describes a specific task (e.g. audit docs, fix lint, author JSON schema, generate workflow, increase test coverage). See below for a full index.
22+
- [`reports/`](./reports/): Generated reports, analysis outputs, and audit files. All Copilot/agent reports must be created here, not in docs/ or repository root.
23+
- [`projects/`](./projects/): Task tracking, project planning, and implementation roadmaps. All task lists and project files must be created here, not in docs/.
2124
- [`README.md`](../README.md): Explains the purpose of the repository and how to use the instructions and prompts.
2225

2326
---

docs/.archive/CONSOLIDATION_MIGRATION_GUIDE.md renamed to .github/instructions/.archive/CONSOLIDATION_MIGRATION_GUIDE.md

File renamed without changes.
File renamed without changes.

docs/.archive/INSTRUCTION_CONSOLIDATION_MIGRATION.md renamed to .github/instructions/.archive/INSTRUCTION_CONSOLIDATION_MIGRATION.md

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
file_type: "instructions"
3+
title: "File Management Guidelines for Copilot Agents (Archived)"
4+
description: "Legacy file location guidance. Superseded by file-output-organization.instructions.md."
5+
version: "v1.0"
6+
last_updated: "2025-12-10"
7+
owners: ["LightSpeedWP Team"]
8+
tags:
9+
["file-management", "copilot", "automation", "documentation", "organization"]
10+
applyTo: "**"
11+
status: "archived"
12+
---
13+
14+
# Archived: File Management Guidelines
15+
16+
Superseded by `file-output-organization.instructions.md`, which now covers permanent locations, temporary working files (`.github/tmp/`), promotion, and cleanup rules. Do not use this archived file for new work.

0 commit comments

Comments
 (0)