docs(contributing): legibility guidelines — comments state behavior, not history - #14135
Merged
Merged
Conversation
…not history The 'why, history and context' guidance was how the section-A findings of epic docker#14074 were born: comments justifying code by referencing since- deleted code. Rule 4 now asks for behavioral statements, and a Legibility section spells out the map-must-stay-truthful rules for comments, file names and error messages. Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
docker-agent
left a comment
docker-agent
left a comment
Contributor
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This is a clean, focused documentation PR that:
- Sharpens Coding Style rule 4 to steer comments toward current behavior rather than history
- Adds a concise new Legibility section (4 sub-rules) reinforcing truthful naming, comments, and error messages
The cross-reference anchor [Legibility](#legibility) in rule 4 resolves correctly to the new heading. No contradictions with existing CONTRIBUTING.md content were found. No code is changed.
39 tasks
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
3 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.
Epic #14074, section G: a short legibility section in CONTRIBUTING.md. Also amends coding-style rule 4, whose "tell us the why, the history and the context" wording is how the section-A findings were born.
🤖 Generated with Claude Code