📝 Require concise prose in development/
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.
This commit is contained in:
1 parent
ae319f6547
commit
c15bc0153e
3 files changed
+7
No files matched your search
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
- upgrade dependencies
|
- upgrade dependencies
|
||||||
- ignore `@types/node` in `maintain:outdated` (misleading `latest` dist-tag)
|
- ignore `@types/node` in `maintain:outdated` (misleading `latest` dist-tag)
|
||||||
|
- require extremely concise prose in `development/`
|
||||||
|
|
||||||
## [0.1.7] - 2026-09-16
|
## [0.1.7] - 2026-09-16
|
||||||
|
|
||||||
|
|||||||
@@ -173,6 +173,9 @@ reaches for by default:
|
|||||||
alternatives and the known issues. When you change a rule, update its category
|
alternatives and the known issues. When you change a rule, update its category
|
||||||
file in the same commit and cross-link the two. (why:
|
file in the same commit and cross-link the two. (why:
|
||||||
[development/README.md](./development/README.md))
|
[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
|
## Branching model
|
||||||
|
|
||||||
|
|||||||
@@ -66,6 +66,9 @@ of downloading per job.
|
|||||||
goes under a `## Known issues` section at the end of the file.
|
goes under a `## Known issues` section at the end of the file.
|
||||||
- Replace a superseded decision in place rather than archiving it; git history
|
- Replace a superseded decision in place rather than archiving it; git history
|
||||||
is the archive.
|
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
|
## Adding to these docs
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user