Skip to content

Latest commit

 

History

History
87 lines (63 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

87 lines (63 loc) · 3.27 KB
Raw

Contribution Guideline

Starknet Foundry is under active development and is open for contributions! Want to get started? Grab any issue labeled with good-first-issue! Need some guidance?

Reach out to other developers on Telegram or open a GitHub discussion!

Environment Setup

See development guide in Starknet Foundry book for environment setup.

Running Tests and Checks

To run tests scripts, you have to install:

⚠️ Make sure you run ./scripts/prepare_for_tests.sh and then set Scarb version compatible with both snforge and sncast after setting up the development environment, otherwise the tests will fail.

Before creating a contribution, make sure your code passes the following checks

$ cargo test
$ cargo fmt --check
$ cargo lint

Otherwise, it won't be possible to merge your contribution.

You can also run a specific set of tests, by directly running cargo test.

For forge tests, make sure you are in crates/forge directory:

$ cargo test --lib        # runs all unit tests
$ cargo test integration  # runs all integration tests
$ cargo test e2e          # runs all e2e tests

Similarly, to run cast tests make sure you are in crates/cast directory:

$ cargo test --lib        # runs lib unit tests
$ cargo test helpers      # runs helpers unit tests
$ cargo test integration  # runs all integration tests
$ cargo test e2e          # runs all e2e tests

Or to run cheatnet tests make sure you are in crates/cheatnet directory:

$ cargo test --lib        # runs lib unit tests
$ cargo test cheatcodes   # runs all cheatcodes tests
$ cargo test starknet     # runs all starknet tests

Contributing

Before you open a pull request, it is always a good idea to search the issues and verify if the feature you would like to add hasn't been already discussed. We also appreciate creating a feature request before making a contribution, so it can be discussed before you get to work.

Writing Tests

Please make sure the feature you are implementing is thoroughly tested with automatic tests. You can check existing tests in the repository to see the recommended approach to testing.

Breaking Changes

If the change you are introducing is changing or breaking the behavior of any already existing features, make sure to include that information in the pull request description.

Pull Request Size

Try to make your pull request self-contained, only introducing the necessary changes. If your feature is complicated, consider splitting the changes into meaningful parts and introducing them as separate pull requests.

While creating large pull requests usually will not prevent them from being merged, it may significantly increase review time and increase the risk of complicated to resolve merge conflicts.