Skip to content

Commit 4514ec3

Browse files
committed
docs: add reporting AGENT.md and template index for the monthly reporting
1 parent b0c8245 commit 4514ec3

2 files changed

Lines changed: 56 additions & 0 deletions

File tree

reporting/AGENTS.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Reporting — Agent Instructions
2+
3+
`TEMPLATE.md` is the canonical template for the monthly update the working group submits to the Technical Committee (TC). Follow these instructions to produce a report from it.
4+
5+
## File Naming
6+
7+
Save each report as `YYYY-MM-report.md` using the year and month of the reporting period (e.g. `2026-06-report.md`).
8+
9+
## Cadence and Deadlines
10+
11+
- One report is due per calendar month, by the **last business day of the month**.
12+
- The TC review window closes **7 calendar days** after submission.
13+
- Merge the report once the TC signs off or the review window closes, whichever is sooner.
14+
15+
## Workflow
16+
17+
1. Copy `TEMPLATE.md` into a new file named for the reporting period (e.g. `2026-06-report.md`).
18+
2. Delete the `HOW TO USE THIS TEMPLATE` comment block before submitting.
19+
3. Fill in the header fields: **Reporting period** (`Month YYYY`) and **Date submitted** (`YYYY-MM-DD`). Leave **Working Group** and **Chair(s)** as-is unless they have changed.
20+
4. Write a 2-3 sentence **Summary** capturing the month at a glance.
21+
5. Populate **Progress Against Objectives**, tying items back to stated objectives where possible.
22+
6. List **Blockers and Risks**. If none, write "None this month."
23+
7. List **Decisions Needed from the TC** as explicit asks. If none, write "None."
24+
8. List the top 2-3 priorities under **Next Month's Focus**.
25+
9. Add relevant PRs, issues, releases, meeting notes, and dashboards under **Metrics / Links**.
26+
10. Open a pull request titled `[Report] WS-Taxonomy & Landscape – Month YYYY` (e.g. `[Report] WS-Taxonomy & Landscape – June 2026`) and add the TC (or the designated TC GitHub team) as reviewers.
27+
11. Add a row to the table in `README.md` for the new report. Insert the row at the top of the table (below the header) so reports remain in descending order by reporting period. The row should contain the reporting period (`YYYY-MM`), a link labeled "Full report" pointing to the report file, and a 1-2 sentence summary of the month.
28+
29+
## Style Guidance
30+
31+
- Keep it short and scannable — the TC reviews async.
32+
- Use concise bullet points, not full paragraphs.
33+
- State each requested decision clearly so it can be actioned in the PR.
34+
35+
## Sections With No Content
36+
37+
Keep the section heading and write "None." (or "None this month.") rather than removing the section. This keeps the structure consistent across reports.
38+
39+
## Communication Style
40+
41+
Apply these guidelines to all writing in this repository, including documents, commit messages, pull request descriptions, and responses to users:
42+
43+
- Do not use contrastive language.
44+
- Do not line break with horizontal rules.
45+
- Don't be a sycophant.
46+
- Be direct, but don't use partial clauses in your sentence structure.
47+
- Use complete thoughts that flow naturally.
48+
- Provide a neutral voice that's both playful but professional at the same time.

reporting/READNE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Reports
2+
3+
All monthly reports submitted by the Taxonomy and Landscape Workstream to the Technical Committee (TC), listed in reverse chronological order.
4+
5+
| Reporting Period | Link | Summary |
6+
|------------------|------|---------|
7+
8+
_No reports have been submitted yet. The first report will cover 2026-06._

0 commit comments

Comments
 (0)