CONTRIBUTING.md

Starklings contributing guide

Thank you for investing your time in contributing to our project!

In this guide you will find the necessary instructions to get up and running with developing Starklings new features or fixing some bugs.

---

Setting up a development environment

Requirements

• Python >=3.8 <3.9

Setting up environment

1. Install Python version management tool: pyenv or asdf
2. Install Python 3.8 using the Python version management tool and activate that version
3. Clone this repository
4. Verify the active Python version: python -V
5. Create Python virtual environment in the project directory: python -m venv env
6. Activate environment: source env/bin/activate
7. Upgrade pip: pip install --upgrade pip
8. Install Poetry — a dependency manager: pip install poetry
9. Install project dependencies: poetry install

Troubleshooting: if you run on a Mac M1, you might encounter the following error: fatal error: 'gmp.h' file not found See OpenZeppelin/nile#22 for detailed solutions.

How can I contribute?

Report a bug or suggest an enhancement

If you spot a problem or have an idea for a cool feature, first make sure there is no related existing issue. If not, you can open a new Issue and add a description of your suggestions.

Submitting changes

Please send a GitHub Pull Request with a list of what your changes accomplish. Make sure to follow the guidelines below.

Development guidelines

See StarkNet development guidelines.

Where can I ask a question?

If you have a question, please ask it in Discord.