Skip to content

Commit ee000c6

Browse files
authored
chore: add guidance on running compatibility checks locally (#623)
Closes: #117 - Add note on testing across compiler version targets locally - Updates links to point to `choose` panels to enforce issue / discussion templates
1 parent 4f57c59 commit ee000c6

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,25 @@ Even minor pull requests, such as those fixing wording, are greatly appreciated.
8080
a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase
8181
the likelihood of the PR getting merged.
8282

83-
Please also make sure that the following commands pass if you have changed the code:
83+
Please make sure that the following commands pass if you have changed the code:
8484

8585
```sh
8686
forge fmt --check
8787
forge test -vvv
8888
```
8989

90+
To make sure your changes are compatible with all compiler version targets, run the following commands:
91+
92+
```sh
93+
forge build --skip test --use solc:0.6.2
94+
forge build --skip test --use solc:0.6.12
95+
forge build --skip test --use solc:0.7.0
96+
forge build --skip test --use solc:0.7.6
97+
forge build --skip test --use solc:0.8.0
98+
```
99+
100+
The CI will also ensure that the code is formatted correctly and that the tests are passing across all compiler version targets.
101+
90102
#### Adding cheatcodes
91103

92104
Please follow the guide outlined in the [cheatcodes](https://github.com/foundry-rs/foundry/blob/master/docs/dev/cheatcodes.md#adding-a-new-cheatcode) documentation of Foundry.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ First, see if the answer to your question can be found in [book](https://book.ge
256256
If the answer is not there:
257257

258258
- Join the [support Telegram](https://t.me/foundry_support) to get help, or
259-
- Open a [discussion](https://github.com/foundry-rs/foundry/discussions/new) with your question, or
260-
- Open an issue with [the bug](https://github.com/foundry-rs/foundry/issues/new)
259+
- Open a [discussion](https://github.com/foundry-rs/foundry/discussions/new/choose) with your question, or
260+
- Open an issue with [the bug](https://github.com/foundry-rs/foundry/issues/new/choose)
261261

262262
If you want to contribute, or follow along with contributor discussion, you can use our [main telegram](https://t.me/foundry_rs) to chat with us about the development of Foundry!
263263

0 commit comments

Comments
 (0)