cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

adding a point about expectations to checklist

Browse Source
This commit is contained in:
George Plotnikov 2022-10-26 15:14:05 +05:00
parent 6374b4fe23
commit b0a729aab8
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
ReviewChecklist.md
View File

@ -26,6 +26,13 @@ It is also meant to serve as a final checklist for reviewers to go through befor
- [ ] Avoid basing PRs from forks on branches other than `develop` or `breaking` because - [ ] Avoid basing PRs from forks on branches other than `develop` or `breaking` because
GitHub closes them when the base branch gets merged. GitHub closes them when the base branch gets merged.
Do this only for PRs created directly in the main repo. Do this only for PRs created directly in the main repo.
- [ ] **Does the PR update test expectations to match the modified code?** If not, your PR will not pass some of the `_soltest_`, jobs in CI.
In many cases the expectations can be updated automatically:
- `cmdlineTests.sh --update` for command-line tests.
- `isoltest --enforce-gas-cost --accept-updates` for soltest-based tests.
- If your PR affects gas costs, an extra run of `isoltest --enforce-gas-cost --optimize --accept-updates` is needed to update gas expectations with optimizer enabled.
- Review updated files before committing them.
**Are expectations correct and do updated tests still serve their purpose?**
## Coding Style and Good Practices ## Coding Style and Good Practices
- [ ] Does the PR follow our [coding style](CODING_STYLE.md)? - [ ] Does the PR follow our [coding style](CODING_STYLE.md)?
@ -127,8 +134,6 @@ The following points are all covered by the coding style but come up so often th
- [ ] **Do not include version pragma and the SPDX comment in semantic and syntax test cases**. - [ ] **Do not include version pragma and the SPDX comment in semantic and syntax test cases**.
In other test types include them if necessary to suppress warnings. In other test types include them if necessary to suppress warnings.
- [ ] **If you have to use a version pragma, avoid hard-coding version.** Use `pragma solidity *`. - [ ] **If you have to use a version pragma, avoid hard-coding version.** Use `pragma solidity *`.
- [ ] **Add `--pretty-print --pretty-json 4` to the `args` file of in command-line tests** to get
readable, indented output.
- [ ] **When writing StandardJSON command-line tests, use `urls` instead of `content`** and put - [ ] **When writing StandardJSON command-line tests, use `urls` instead of `content`** and put
the Solidity or Yul code in a separate file. the Solidity or Yul code in a separate file.