dld-implement: discourage duplicating decision context in comments#24
Merged
Conversation
Add opinionated guidance to the annotation step: default to the bare @Decision annotation, don't restate the decision's rationale in code comments, and only add further comments when the code itself is non-obvious. Keeps the decision record as the single source of truth.
Clarify guidelines on decision annotations and comments.
Clarified guidelines on commenting decisions in code.
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
2 participants
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.
Add opinionated guidance to the annotation step: default to the bare
@Decision annotation, don't restate the decision's rationale in code
comments, and only add further comments when the code itself is
non-obvious. Keeps the decision record as the single source of truth.