docs: require self-contained code comments - #24239
Merged
PhilWindle merged 1 commit intoJun 24, 2026
Merged
Conversation
Collaborator
Flakey Tests🤖 says: This CI run detected 2 tests that failed, but were tolerated due to a .test_patterns.yml entry. |
PhilWindle
approved these changes
Jun 24, 2026
rangozd
pushed a commit
to rangozd/aztec-packages
that referenced
this pull request
Aug 5, 2026
BEGIN_COMMIT_OVERRIDE docs: add network-deployed-version skill (AztecProtocol#24238) docs: require self-contained code comments (AztecProtocol#24239) fix(archiver): validate checkpoint attestations from calldata before fetching blobs (A-1252) (AztecProtocol#24247) fix(sequencer): prune in failed-sync fallback so the chain can recover (AztecProtocol#24253) END_COMMIT_OVERRIDE
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.
Adds a rule to the
<writing_comments>section of the rootCLAUDE.md: code comments must be understandable from the repo alone.// see A-1234).// this fixes item 4,// tackles section C) — describe the actual constraint or behavior instead.Placed in the root
CLAUDE.md(notyarn-project/) since it applies to comments in any language across all components, alongside the existing rule against referencing PR/issue numbers.