Conversation
Adds a new "caller-context leak" anti-pattern to the code-comments
knowledge file. Doc comments describe what a function promises to any
caller; justifying that promise in terms of one specific caller's
situation (e.g. `--check` mode, a wizard's flow) leaks context that the
reader doesn't have. The contract should be stated on its own terms,
with caller-specific reasoning reserved for a `//` comment at the call
site. A good/bad example pair illustrates the distinction.
The forbidden-words list in the default persona is tightened: the escape
clause ("unless there is a very good reason") is removed, and two new
entries are added — `load-bearing` and `*em dashes*` — keeping the list
consistent with observed failure patterns.
Also corrects the architecture knowledge file to reflect that JP is now
developed by three human authors rather than one.
Signed-off-by: Jean Mertz <git@jeanmertz.com>
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
1 participant
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.
Adds a new "caller-context leak" anti-pattern to the code-comments knowledge file. Doc comments describe what a function promises to any caller; justifying that promise in terms of one specific caller's situation (e.g.
--checkmode, a wizard's flow) leaks context that the reader doesn't have. The contract should be stated on its own terms, with caller-specific reasoning reserved for a//comment at the call site. A good/bad example pair illustrates the distinction.The forbidden-words list in the default persona is tightened: the escape clause ("unless there is a very good reason") is removed, and two new entries are added —
load-bearingand*em dashes*— keeping the list consistent with observed failure patterns.Also corrects the architecture knowledge file to reflect that JP is now developed by three human authors rather than one.