From 4d791146f87be0e8ea6ba0a0d62451f3f69ab86b Mon Sep 17 00:00:00 2001 From: zerosnacks Date: Fri, 11 Oct 2024 10:27:02 +0200 Subject: [PATCH 1/2] add guidance on running compatibility checks locally --- CONTRIBUTING.md | 10 ++++++++++ README.md | 4 ++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c57268b7..7185dd18 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -87,6 +87,16 @@ forge fmt --check forge test -vvv ``` +To make sure your changes are compatible with all compiler version targets, run the following commands: + +```sh +forge build --skip test --use solc:0.6.2 +forge build --skip test --use solc:0.6.12 +forge build --skip test --use solc:0.7.0 +forge build --skip test --use solc:0.7.6 +forge build --skip test --use solc:0.8.0 +``` + #### Adding cheatcodes 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. diff --git a/README.md b/README.md index f039ec6f..90af03b0 100644 --- a/README.md +++ b/README.md @@ -256,8 +256,8 @@ First, see if the answer to your question can be found in [book](https://book.ge If the answer is not there: - Join the [support Telegram](https://t.me/foundry_support) to get help, or -- Open a [discussion](https://github.com/foundry-rs/foundry/discussions/new) with your question, or -- Open an issue with [the bug](https://github.com/foundry-rs/foundry/issues/new) +- Open a [discussion](https://github.com/foundry-rs/foundry/discussions/new/choose) with your question, or +- Open an issue with [the bug](https://github.com/foundry-rs/foundry/issues/new/choose) 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! From 5af436d7182457e51ae5410e287e81bd5b1ea91f Mon Sep 17 00:00:00 2001 From: zerosnacks Date: Fri, 11 Oct 2024 10:30:44 +0200 Subject: [PATCH 2/2] add note on CI --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7185dd18..89b75f3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -80,7 +80,7 @@ Even minor pull requests, such as those fixing wording, are greatly appreciated. a good idea to first open an issue describing the change to solicit feedback and guidance. This will increase the likelihood of the PR getting merged. -Please also make sure that the following commands pass if you have changed the code: +Please make sure that the following commands pass if you have changed the code: ```sh forge fmt --check @@ -97,6 +97,8 @@ forge build --skip test --use solc:0.7.6 forge build --skip test --use solc:0.8.0 ``` +The CI will also ensure that the code is formatted correctly and that the tests are passing across all compiler version targets. + #### Adding cheatcodes 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.