Skip to content

Commit 928026c

Browse files
committed
Merge commit '644f2aba506d674f84e8e0f6000e67472657d755' into dev
* commit '644f2aba506d674f84e8e0f6000e67472657d755': Add OSBot-Playwright research report and report placement conventions
2 parents 0e60219 + 644f2ab commit 928026c

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Convention: Dev Role Report Placement
2+
3+
**Document identifier:** conventions__report-placement
4+
**Version:** v0.1.0
5+
**Date:** 2026-02-10
6+
**Status:** Active
7+
8+
---
9+
10+
## Report Location
11+
12+
All Dev role research reports, experiment logs, and investigation outputs go into:
13+
14+
```
15+
roles/Issues-FS__Dev__Role__Dev/docs/reports/
16+
```
17+
18+
## Naming Convention
19+
20+
```
21+
v{version}__{type}__{topic}.md
22+
```
23+
24+
Where:
25+
- **version** matches the Dev role version at time of creation (e.g., `v0.1.4`)
26+
- **type** is one of: `report`, `experiment`, `investigation`, `poc`
27+
- **topic** is a kebab-case description (e.g., `osbot-playwright-research`)
28+
29+
### Examples
30+
31+
```
32+
v0.1.4__report__osbot-playwright-research.md
33+
v0.1.5__experiment__memory-fs-sqlite-backend.md
34+
v0.1.6__investigation__type-safe-migration-gaps.md
35+
v0.1.7__poc__graph-based-test-runner.md
36+
```
37+
38+
## Report Structure
39+
40+
Reports should include at minimum:
41+
42+
1. **Header** with date, researcher role(s), and status
43+
2. **What** was investigated and why
44+
3. **What was tried** (exact commands, code, outputs)
45+
4. **What worked** and **what didn't** (be honest about failures)
46+
5. **Issues found** (code-level or environment-level)
47+
6. **Recommendations** for the ecosystem
48+
49+
## Rationale
50+
51+
Reports are versioned alongside the Dev role to maintain traceability. They live in the Dev role repo (not the parent orchestration repo) because:
52+
- They are Dev role artifacts
53+
- They can be found by reading the Dev role repo
54+
- They don't clutter the orchestration repo

0 commit comments

Comments
 (0)