-
Notifications
You must be signed in to change notification settings - Fork 152
docs: Add EIP checklist templates #1327
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left some comments, this is after a first pass of this checklist :) Will check again later and when I think of more "exotic" cases, will add them. I might have commented on some cases which are already added, but which I missed (sorry about that).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome so far! I will come back to this after you have pushed your changes. Some thoughts you might want to include.
This is a great idea, I'm going to push to have this finished today and merged. |
@danceratopz @spencer-tb I think this one is ready to merge. Let me know what you think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
EIP EL checklist is really an amazing document.
I def think we should publish this on eest.ethereum.org for ease of sharing (the tables format really well, too)!
Added that suggestion and fixed some formatting here:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an amazing document, thanks @marioevz, @jochem-brouwer, @winsvega, @spencer-tb! I think it's going to be extremely useful.
Looking forward to the plugin π
I addressed a few formatting issues in #1601 and just pushed some small cosmetic changes. I have one remaining comment below. Otherwise, a preemptive approve from me :)
docs/writing_tests/checklist_templates/eip_testing_checklist_template.md
Show resolved
Hide resolved
Co-authored-by: danceratopz <[email protected]> Co-authored-by: spencer-tb <[email protected]> Co-authored-by: Jochem Brouwer <[email protected]>
* chore(docs): auto-format doc, in particular tables, with prettier * chore(docs): remove periods from sub-titles * chore(docs): fix indentation in unordered lists * chore(docs): add missing md table headers * refactor(docs): indent navigation ready for more deeply nested entries * docs: add testing checklists to docs/writing; include in html * docs: update whitelist * docs: disable MD001 for eip testing checklist
) * docs: Add first checklist templates * changes: Precompiles * changes: System contracts * nit * changes: Add (incomplete) transaction tests * More changes * Add more encoding tests * More cases * More test vectors * More review comments * Add asymetrical stack tests * Add some IDs * Add serialization items * Add more serialization items * Add gas refunds category * docs: Add post-mortems * fix(github): Add the post-mortem docs to the PR template * fix: Remove references to EOF * fix: Review comments Co-authored-by: danceratopz <[email protected]> Co-authored-by: spencer-tb <[email protected]> Co-authored-by: Jochem Brouwer <[email protected]> * Add gas tests * Simplify bullet points * fix(docs): tox * Add more ids * Add more ids * Add more ids * Add more ids * fix: tox * refactor(docs): Convert EIP checklist to table * fixes * Eip checklist suggestions (ethereum#1601) * chore(docs): auto-format doc, in particular tables, with prettier * chore(docs): remove periods from sub-titles * chore(docs): fix indentation in unordered lists * chore(docs): add missing md table headers * refactor(docs): indent navigation ready for more deeply nested entries * docs: add testing checklists to docs/writing; include in html * docs: update whitelist * docs: disable MD001 for eip testing checklist * chore(docs): more consistent display of opcodes; fix capitalization * fix(docs): Add fuzzing snippet * docs: Changelog --------- Co-authored-by: danceratopz <[email protected]> Co-authored-by: spencer-tb <[email protected]> Co-authored-by: Jochem Brouwer <[email protected]>
) * docs: Add first checklist templates * changes: Precompiles * changes: System contracts * nit * changes: Add (incomplete) transaction tests * More changes * Add more encoding tests * More cases * More test vectors * More review comments * Add asymetrical stack tests * Add some IDs * Add serialization items * Add more serialization items * Add gas refunds category * docs: Add post-mortems * fix(github): Add the post-mortem docs to the PR template * fix: Remove references to EOF * fix: Review comments Co-authored-by: danceratopz <[email protected]> Co-authored-by: spencer-tb <[email protected]> Co-authored-by: Jochem Brouwer <[email protected]> * Add gas tests * Simplify bullet points * fix(docs): tox * Add more ids * Add more ids * Add more ids * Add more ids * fix: tox * refactor(docs): Convert EIP checklist to table * fixes * Eip checklist suggestions (ethereum#1601) * chore(docs): auto-format doc, in particular tables, with prettier * chore(docs): remove periods from sub-titles * chore(docs): fix indentation in unordered lists * chore(docs): add missing md table headers * refactor(docs): indent navigation ready for more deeply nested entries * docs: add testing checklists to docs/writing; include in html * docs: update whitelist * docs: disable MD001 for eip testing checklist * chore(docs): more consistent display of opcodes; fix capitalization * fix(docs): Add fuzzing snippet * docs: Changelog --------- Co-authored-by: danceratopz <[email protected]> Co-authored-by: spencer-tb <[email protected]> Co-authored-by: Jochem Brouwer <[email protected]>
ποΈ Description
This PR aims to introduce EIP checklist templates that must be followed when implementing tests for a given EIP.
π Related Issues
β Checklist
mkdocs serve
locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.