clawdie/layered-soul
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request 'docs: frame content-type naming as a positive decision in USER.md' (#15) from reframe-naming-decision into main

Browse source 
Reviewed-on: #15
This commit is contained in:
clawdie 2026-06-21 16:55:39 +02:00
commit 35c16638ff
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
USER.md
View file

@ -41,7 +41,8 @@ TTS voice preference: sl-SI-RokNeural (Slovenian)
says `Run as: sh script.sh`, not also `NOT as: python3 script.sh`. says `Run as: sh script.sh`, not also `NOT as: python3 script.sh`.
- **Plain language over jargon.** Branch/PR names a non-technical operator can read - **Plain language over jargon.** Branch/PR names a non-technical operator can read
(`all-checks-green`, not `chore/rustfmt-clean`); avoid `fmt`/`lint`/`CI` in names. (`all-checks-green`, not `chore/rustfmt-clean`); avoid `fmt`/`lint`/`CI` in names.
Say "detection"/"discovery", not "sniffing". Commit *bodies* can still be precise. We name content/file-type recognition "detection" or "discovery" (a settled
naming decision). Commit *bodies* can still be precise.
- **Lean, current docs.** When a decision/design ships as working code, slim its doc to - **Lean, current docs.** When a decision/design ships as working code, slim its doc to
a short "how it works now" and point at the real files (code is source of truth); flip a short "how it works now" and point at the real files (code is source of truth); flip
`Proposed` → `Accepted — implemented`, drop migration/to-do sections. No history `Proposed` → `Accepted — implemented`, drop migration/to-do sections. No history