Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.82 KB

Contribution Guideline

Starknet Foundry is under active development and is open for contributions!

Opening an issue

If you think something doesn't work or something is missing please open an issue! This way we can address this problem and make Starknet Foundry better! Before opening an issue, it is always a good idea to search existing issues and verify if a similar one doesn't already exist.

Contributing

Environment setup

See development guide in Starknet Foundry book for environment setup.

Selecting an issue

If you are a first time contributor pick up any issue labeled as good-first-issue. Write a comment that you would like to work on it and we will assign it to you. Need some guidance? Reach out to other developers on Telegram.

If you are a more experienced Starknet Foundry contributor you can pick any issue labeled as help-wanted. Make sure to discuss the details with the core team beforehand.

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.

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.

Creating very large pull requests may significantly increase review time or even prevent them from being merged.

Contributions Related to Spelling and Grammar

At this time, we will not be accepting contributions that only fix spelling or grammar errors in documentation, code or elsewhere.