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

Fix minor typos #164

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ First take a look at our [specs](https://github.com/privacy-scaling-explorations
2. Write a simple markdown spec doc about the PR and send to the `zkevm-specs` repo.
- ******************NOTE:****************** If the PR changes the circuit behavior, it is encouraged to reflect the changes in high level python ([here](https://github.com/privacy-scaling-explorations/zkevm-specs/tree/master/src/zkevm_specs)) and submit them along the same PR with the markdown spec to `zkevm-specs` repo.
3. We encourage everyone to [open an issue](https://github.com/privacy-scaling-explorations/zkevm-circuits/issues/new/choose) and wait until this feature/proposal gets approved by the repo maintainers before getting to work on a PR. However, this is a must for PRs that change significantly the codebase or the way on which some procedure is done (test-suite, cross-crate structures, module refactors).
4. Create a separate branch that will host all commits. Give branch names succinct title describing the change.
4. Create a separate branch that will host all commits. Give branch names a succinct title describing the change.
5. Start to make your changes. Please also make sure that the following commands pass if you have changed the code:

```
make test
make clippy
```

6. Once you made the changes, give the commit message a sufficient description of the change. The message content can be brief, including only enough details to summarize the purpose of the commit. In other instances, more in-depth explanations about how the commit accomplishes its goals are better suited as comments in the code.
6. Once you've made the changes, give the commit message a sufficient description of the change. The message content can be brief, including only enough details to summarize the purpose of the commit. In other instances, more in-depth explanations about how the commit accomplishes its goals are better suited as comments in the code.
- ******************NOTE:****************** The commits in a pull request should be organized in a manner where each commit represents a small, coherent step towards the pull request's overall objective. The structure of the pull request should facilitate the reviewer in easily tracking and understanding each change made.
7. Send the circuit PR to the `zkevm-circuits` repo. Make sure you give a clear title and succinct description of the PR and the area you are changing.
- ******************NOTE:****************** Make atomic PRs. Focused on a single feature or topic. Don't mix different topics or issues in the same PR if it can be avoided.
Expand All @@ -44,7 +44,7 @@ First take a look at our [specs](https://github.com/privacy-scaling-explorations

### Submitting Bug Issues

1. If you identified a bug, please create a new issue or discuss it in our [forums](https://github.com/privacy-scaling-explorations/zkevm-circuits/discussions).
1. If you've identified a bug, please create a new issue or discuss it in our [forums](https://github.com/privacy-scaling-explorations/zkevm-circuits/discussions).
2. In the description, provide the following:
- Describe the bug
- Concrete steps to reproduce the bug
Expand Down Expand Up @@ -90,4 +90,4 @@ A: You don’t need permissions from PSE, can just create an issue or propose a

Q: Is there a forum for discussing different issues or features where I can get started?

A: There’s the issues section in zkevm repos, but for more nuanced discussion join our [Github Discussions](https://github.com/privacy-scaling-explorations/zkevm-circuits/discussions) or [discord](https://discord.com/invite/sF5CT5rzrR).
A: There’s an issues section in zkevm repos, but for more nuanced discussion join our [Github Discussions](https://github.com/privacy-scaling-explorations/zkevm-circuits/discussions) or [discord](https://discord.com/invite/sF5CT5rzrR).
2 changes: 1 addition & 1 deletion testool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Sometimes there are some files or specific tests that we want to disable at all.

When the command line parameter `--report` is defined, it automatically:

- After the execution, a two files are created in the `report` folder. They are
- After the execution, two files are created in the `report` folder. They are
- `<timestamp>-<git_commit>.hml` with the browseable results of the execution.
- `<timestamp>-<git_commit>.csv` with the raw results of the execution
- The HTML file also contains the diff with the previous result. The previous result file is the more recent csv file with different commit from the current one
Expand Down
Loading