Repository navigation
Conversation
Module READMEs no longer have to change with every production change. AGENTS.md, the README template and the CodeRabbit rules now ask for an update only when a module's purpose, public API, structure, dependencies, threading or stable names and IDs change, and list what doesn't belong in a README. ModuleReadmeBudgetTest keeps READMEs under 2,000 words with no dates or plan labels; older READMEs may only shrink.
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 32 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
|
Member
Author
|
Pushed directly to master in 128ab5d. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Motivation
What changed
AGENTS.md: update the module README only when its purpose, public API, structure, dependencies, threading, or stable names and IDs change; rewrite lines rather than add them; never record history, labels, measurements, test lists or server/security details..coderabbit.yaml: the module README rule, the three per-path rules, the README path rule and the "Module README updated" pre-merge check now follow that rule instead of requiring an edit for any production change; the stale changelog instruction now points at the PR changelog region and the listener notes list.docs/MODULE_README_TEMPLATE.md: a 500–2,000 word budget, one idea per bullet, nothing after "See also", and a "What doesn't belong" table saying where each kind of detail goes instead.ModuleReadmeBudgetTest(:core:testing): fails when a module README passes 2,000 words, holds dates or plan/decision labels, or has non-list lines after "See also". READMEs over those limits today are listed with their current numbers incore/testing/src/test/resources/module-readme-budget.txtand may only shrink.docs/TESTING.md: lists the new check.Behavior & compatibility
Release copy
Changed
ModuleReadmeBudgetTestkeeps them under 2,000 words with no dates or plan labels, and older READMEs may only shrink.Test plan
:core:testingarchitecture tests pass locally, including the newModuleReadmeBudgetTest(3 tests)detektand:core:testing:ktlintCheckpass