46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
# DR Issue Log Format
|
|
|
|
## Canonical Format (updated Jul 8, 2026)
|
|
|
|
The DR issue log at `/root/.hermes/references/dr-issue-log.md` must follow this format:
|
|
|
|
### Summary Section
|
|
Grouped by status, NOT pipe tables:
|
|
```
|
|
**Fixed** [OK]
|
|
- **DR-NNN** [SEVERITY] One-line description -> what was done
|
|
|
|
**Resolved** [INFO]
|
|
- **DR-NNN** [INFO] One-line description -> resolution
|
|
|
|
**Investigating** [PENDING]
|
|
- **DR-NNN** [SEVERITY] One-line description
|
|
```
|
|
|
|
### Individual Entries
|
|
```
|
|
### DR-NNN -- Title `[SEVERITY] [STATUS] StatusWord`
|
|
|
|
**Problem**
|
|
One or two sentences describing what was wrong.
|
|
|
|
**Root Cause**
|
|
What caused it.
|
|
|
|
**Fix**
|
|
What was done to fix it (bullet list if multiple steps).
|
|
|
|
**Verification**
|
|
- [OK] How verification was done
|
|
```
|
|
|
|
### Key Rules
|
|
- No emoji (no 🔴🟡🟢✅🔄→—×)
|
|
- Severity tags: `[HIGH]`, `[MED]`, `[INFO]`
|
|
- Status tags: `[OK] Fixed`, `[PENDING] Investigating`, `[OK] Resolved`
|
|
- Arrows: use `->` not `→`
|
|
- Em dashes: use ` -- ` (space-hyphen-hyphen-space) not ` — ` (space-emdash-space)
|
|
- Verification checks: `[OK]` not `✅`
|
|
- No pipe tables anywhere — use bullet lists with bold lead-ins
|
|
- Each entry is separated by `---`
|