README Guardrails¶
Guardrails¶
- do not rewrite the README around a single feature unless the project identity truly changed
- preserve project-level balance when adding new capabilities
- keep setup, install, and first-use guidance as the easiest thing to find
- move deep detail into dedicated docs instead of bloating the README
- treat the README as a routing surface, not a subsystem spec
- review major README edits for newcomer usefulness and proportionality
Default Rule For New Features¶
Most new features should cause:
- a small README mention if they materially affect the project
- a deeper dedicated doc elsewhere
They should not cause:
- a full README rewrite
- a new dominant section unless they truly redefine the project