Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

Latest commit

 

History

History
15 lines (11 loc) · 942 Bytes

CONTRIBUTING.md

File metadata and controls

15 lines (11 loc) · 942 Bytes

How to contribute code to smol🤏evm

If you want to contribute an instruction that has not been implemented yet:

  1. look up the opcode's behavior in the yellow paper
  2. build some intuition with evm.codes
  3. clone this repository, create a new branch
  4. implement the missing instruction in opcodes.py
  5. write some unit tests, ideally checking for both happy cases and weird/extreme values, overflows, etc
  6. make sure the tests pass: poetry run pytest -v
  7. open a pull request!
  8. ping karma if you don't hear back reasonably fast

If you need some inspiration, check out this commit that implements a handful of instructions and the corresponding tests.