quill: add draft artifact naming convention RFC
This commit is contained in:
1 parent
0af802f211
commit
039246958f
1 file changed
+48
@@ -0,0 +1,48 @@
|
||||
# Draft Artifact Naming Convention
|
||||
|
||||
## Status
|
||||
Proposed — 2026-10-25
|
||||
|
||||
## Problem
|
||||
Wizard outputs in `/root/.hermes/wizard-outputs/quill/` use inconsistent naming:
|
||||
hyphen-case, snake_case, and free-form titles. This makes automated verification,
|
||||
retrieval, and audit noisy.
|
||||
|
||||
## Proposal
|
||||
Adopt a strict naming scheme for all new drafts produced in this lane:
|
||||
|
||||
### Format
|
||||
```
|
||||
<slug>-<type>-<date>.md
|
||||
```
|
||||
|
||||
| Field | Rule | Example |
|
||||
|-------------|-------------------------------------------|-----------------------|
|
||||
| `<slug>` | lowercase hyphen-case, 2-4 words | `draft-artifact` |
|
||||
| `<type>` | one of: `brief`, `template`, `runbook`, `rfc`, `sop`, `checklist` | `template` |
|
||||
| `<date>` | `YYYYMMDD` | `20261025` |
|
||||
|
||||
### Examples
|
||||
- `issue-to-draft-brief-template-20261025.md`
|
||||
- `postmortem-template-20261025.md`
|
||||
- `free-tier-bot-crew-checklist-20261025.md`
|
||||
|
||||
### Exceptions
|
||||
- Artifacts that are not prose (scripts, JSON, YAML) keep their natural extension.
|
||||
- Legacy artifacts are not renamed; convention applies to new work only.
|
||||
|
||||
## Rationale
|
||||
- Machine-sortable by date.
|
||||
- Human-readable.
|
||||
- Avoids collisions in shared scratch spaces.
|
||||
|
||||
## Adoption
|
||||
Apply to every new file written under:
|
||||
- `/root/.hermes/wizard-outputs/quill/`
|
||||
- `/root/troupe-standup/wizard-work/quill/`
|
||||
|
||||
## Checklist
|
||||
- [ ] All new draft filenames match `<slug>-<type>-<date>.md`
|
||||
- [ ] `<type>` chosen from the approved list
|
||||
- [ ] Date in file content matches filename date
|
||||
- [ ] No legacy artifact renamed during adoption
|
||||
Reference in new issue
Block a user