chore(tooling): add test-docstring guidance to the write-test skill - #3328
Merged
marioevz merged 1 commit intoAug 6, 2026
Merged
Conversation
spencer-tb
marked this pull request as ready for review
August 6, 2026 12:56
Contributor
Author
|
PR created by yours truly, fable 5 :) |
2 tasks
CPerezz
added a commit
that referenced
this pull request
Aug 7, 2026
…3332) * feat(tests): add eth_getTransactionReceipt batching (#3298) * feat(tests): add EIP-2780 coverage gap tests (#3318) * feat(test-tests): add engine payload attribute and genesis parity tests (#3309) * fix(test-execute): register per-test hive test cases with the shared client (#3317) * fix(tests): accept gas allowance error at EIP-7778 admission gate (#3330) * chore(tooling): add test-docstring guidance to the write-test skill (#3328) --------- Co-authored-by: Jochem Brouwer <jochembrouwer96@gmail.com> Co-authored-by: spencer <spencer.taylor-brown@ethereum.org> Co-authored-by: danceratopz <danceratopz@gmail.com> Co-authored-by: milen <94537774+taratorio@users.noreply.github.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
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.
Description
Adds a "Test Docstrings" section to the write-test skill: keep test docstrings to a short summary of the rule under test, don't narrate what the code already expresses (parametrized cases, gas decompositions, case-by-case outcomes), prefer inline comments for anything the code can't show, and never hardcode numeric gas values.
Follows the review feedback on #3318.
Related Issues or PRs
N/A.
Checklist
just static<type>(<area>): <title>, where<type>and<area>come from an appropriateC-<type>, respectivelyA-<area>, label. The title should match the target squash commit message.Cute Animal Picture