Skip to content

Commit b0a729a

Browse files
committed
adding a point about expectations to checklist
1 parent 6374b4f commit b0a729a

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

ReviewChecklist.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ It is also meant to serve as a final checklist for reviewers to go through befor
2626
- [ ] Avoid basing PRs from forks on branches other than `develop` or `breaking` because
2727
GitHub closes them when the base branch gets merged.
2828
Do this only for PRs created directly in the main repo.
29+
- [ ] **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.
30+
In many cases the expectations can be updated automatically:
31+
- `cmdlineTests.sh --update` for command-line tests.
32+
- `isoltest --enforce-gas-cost --accept-updates` for soltest-based tests.
33+
- 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.
34+
- Review updated files before committing them.
35+
**Are expectations correct and do updated tests still serve their purpose?**
2936

3037
## Coding Style and Good Practices
3138
- [ ] 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
127134
- [ ] **Do not include version pragma and the SPDX comment in semantic and syntax test cases**.
128135
In other test types include them if necessary to suppress warnings.
129136
- [ ] **If you have to use a version pragma, avoid hard-coding version.** Use `pragma solidity *`.
130-
- [ ] **Add `--pretty-print --pretty-json 4` to the `args` file of in command-line tests** to get
131-
readable, indented output.
132137
- [ ] **When writing StandardJSON command-line tests, use `urls` instead of `content`** and put
133138
the Solidity or Yul code in a separate file.
134139

0 commit comments

Comments
 (0)