Skip to content

Commit

Permalink
Fix typos and improve clarity in contribution guidelines
Browse files Browse the repository at this point in the history
- Fixed minor grammatical issues for improved readability and consistency.
  • Loading branch information
savvar9991 authored Dec 5, 2024
1 parent baca720 commit 0b4d290
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ the repository:

- Integrator: adds a test suite, runs the suite, makes an issue for each failing
test, marks failing tests as skipped.
- Debugger: picks an issue raised by a Integrator, and dives in the EVM spec and
the current Cairo 0 implementation in order to pin point the exact issue. Ones
- Debugger: picks an issue raised by an Integrator, and dives in the EVM spec and
the current Cairo 0 implementation in order to pin point the exact issue. Once
the issue is correctly understood, checks if a similar issue hasn't been
raised by another Debugger yet. If it has, link the Integrator issue to the
Debugger issue for tracking and pick up another Integrator issue. If it
hasn't, raises a detailed issue about the Cairo 0 implementation bug and links
hasn't, raises a detailed issue about the Cairo 0 implementation bug and links
it to the Integrator issue.
- Implementor: picks up an detailed issue raised by a Debugger and reimplements
the test logic in Cairo 0 python tests. Once the error is replicated, fixes
- Implementor: picks up a detailed issue raised by a Debugger and reimplements
the test logic in Cairo 0 Python tests. Once the error is replicated, fixes
the test in Cairo 0.

## How to
Expand All @@ -42,7 +42,7 @@ To start:
`make ef-tests`. After a while (count 10-15 minutes) the test will end and you
should have in your terminal's output a list of all the failing tests.
- Start making issues. When raising issues, please try to match other
`Integrator` issued on the style, and don't forget to add any raised issue to
`Integrator` issues on the style, and don't forget to add any raised issue to
the `epic` issue's task list.

Please find [here](https://github.com/kkrt-labs/ef-tests/issues/52) an example
Expand All @@ -55,7 +55,7 @@ Pick an issue from the available `Integrator` issues. Verify that the test fails
it does, you can start debugging it. The following documentation can be used:

- [Test fillers](https://github.com/ethereum/tests/tree/develop/src/GeneralStateTestsFiller):
used to generated the actual test. This can be used to understand what code
used to generate the actual test. This can be used to understand what code
the transaction executes.
- [Execution specs](https://github.com/ethereum/execution-specs/tree/master):
Ethereum execution specifications written in Python. This can be used to
Expand All @@ -82,10 +82,10 @@ Ethereum/test:
blockifier = { git = "https://github.com/jobez/blockifier.git", rev = "7f00407" }
```

- In the file `./kakarot-rpc/lib/kakarot/src/kakarot/instructions.cairo`, add
- In the file `./kakarot-rpc/lib/kakarot/src/kakarot/instructions.`, add
the following hint `%{print(ids.opcode, ids.ctx) %}` right after line 65. See
the following
[gist](https://gist.github.com/jobez/42941db9361d81778abd36309dfb60dc#file-instructions-cairo-L68-L70)
[gist](https://gist.github.com/jobez/42941db9361d81778abd36309dfb60dc#file-instructions--L68-L70)
for more details.
- From the root of the `kakarot-rpc` repository, run the following:

Expand Down Expand Up @@ -124,10 +124,10 @@ allowing for better tracing of the error. In order to set this up:
folder for help.
- Call `eth_send_transaction` with the exact same arguments as the transaction
from your test. If the error you get is the same as the error on the ef-tests
repository, you can now start debugging using hints in the Cairo 0 code.
repository, you can now start debugging using hints in the 0 code.
- In order to run only your test, use `poetry run pytest -k your_test_name`.
- Debug the Cairo 0 code by adding `%{print(ids.x)%}` to print variables (where
x is the variable you want to print). Be sure to recompile your Cairo 0 code
- Debug the 0 code by adding `%{print(ids.x)%}` to print variables (where
x is the variable you want to print). Be sure to recompile your 0 code
EVERY TIME you make changes, by running `make build`.

### Implementor
Expand Down

0 comments on commit 0b4d290

Please sign in to comment.