diff options
| author | Thomas Vanbesien <tvanbesi@proton.me> | 2026-07-03 16:48:28 +0200 |
|---|---|---|
| committer | Thomas Vanbesien <tvanbesi@proton.me> | 2026-07-03 20:51:26 +0200 |
| commit | 8f703f80721f66dcee58ba404266a858053c76be (patch) | |
| tree | f41057aa7af09efa4c29273e478aef91418fa455 /CLAUDE.md | |
| parent | 5092ee36d92551c8e2b70f978c119f37839aaf92 (diff) | |
| download | claude-config-master.tar.gz claude-config-master.zip | |
Diffstat (limited to 'CLAUDE.md')
| -rw-r--r-- | CLAUDE.md | 16 |
1 files changed, 7 insertions, 9 deletions
@@ -39,15 +39,13 @@ All instructions here apply to the subsections. - **Trim docs** — Cut default/obvious behavior and anything docs/code already say; don't restate the same fact in two sections. - **Lead with the point.** Open a list item with its key word(s) in bold, then the detail — so the list scans by its bold lead-ins alone. - **Generic examples** unless there's no choice — don't bake in repo- or machine-specific paths/names when a placeholder carries the point. -- **Semantic line breaks**: - - **This is VERY IMPORTANT** and has to be applied to all prose without exception: git commit messages, `CLAUDE.md` files, READMEs, code comments, documentation, etc… - - Break the *source* at thought boundaries — rendered output is unchanged. - - Default: one line per sentence — a sentence is one "meaning unit". - MUST break after every sentence (`.` `!` `?`). - - Mid-sentence, only SHOULD break at a genuine *independent* clause (`;`, or `,`/`:`/`—` when a full subject-and-verb clause follows), and only a few times in a long sentence. - - Do NOT break for an appositive, elaboration, parenthetical, or introductory/dependent clause — even after `,`/`:`/`—`, keep the whole meaning unit on one line. - - Never a fragment-per-line. No hard wrap limit — a long single-clause sentence stays one line. - - Never break inside a hyphenated word or inline markup/link. +- **Semantic line breaks** — add a line break after each substantial *unit of thought*, i.e. don't write unbroken blocks of text. + **VERY IMPORTANT** — has to be applied to all prose without exception: git commit messages, `CLAUDE.md` files, READMEs, code comments, documentation, etc… + - Default: one line per *unit of thought*. + - *MUST* break after every sentence (`.` `!` `?`). + - *MUST* still hard wrap — limit depends on language. + - *SHOULD* break mid-sentence at a genuine independent clause (`;`, or `,`/`:`/`—` when a full subject-and-verb clause follows). + - *MUST NOT* break for an appositive, elaboration, parenthetical, or introductory/dependent clause — even after `,`/`:`/`—`. #### Comments |
