From c15bc0153e0952d5f440fad3629240ab021c2194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20M=C3=BCller?= Date: Wed, 16 Sep 2026 08:00:36 +0000 Subject: [PATCH] :memo: Require concise prose in development/ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Actionable sentence in CONTRIBUTING.md § Rules the tools don't enforce; the why — humans skim, agents imitate the dominant style, so verbosity compounds — in development/README.md § Decision blocks. Both sides in one commit per the write-each-fact-once rule. --- CHANGELOG.md | 1 + CONTRIBUTING.md | 3 +++ development/README.md | 3 +++ 3 files changed, 7 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4f03638..3e96576 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - upgrade dependencies - ignore `@types/node` in `maintain:outdated` (misleading `latest` dist-tag) +- require extremely concise prose in `development/` ## [0.1.7] - 2026-09-16 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8d8f86..7d69176 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -173,6 +173,9 @@ reaches for by default: alternatives and the known issues. When you change a rule, update its category file in the same commit and cross-link the two. (why: [development/README.md](./development/README.md)) +- **Prose in `development/` is extremely concise.** When adding or changing a + decision, write fragments if needed — sacrifice grammar for concision. (why: + [development/README.md § Decision blocks](./development/README.md#decision-blocks)) ## Branching model diff --git a/development/README.md b/development/README.md index dd827ce..e93c5b5 100644 --- a/development/README.md +++ b/development/README.md @@ -66,6 +66,9 @@ of downloading per job. goes under a `## Known issues` section at the end of the file. - Replace a superseded decision in place rather than archiving it; git history is the archive. +- Terse is the point: humans skim and agents imitate the style already in the + file, so verbosity compounds edit over edit. Grammar loses to density here on + purpose. ## Adding to these docs