Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 1.56 KB

Contribution Guidelines for StarkDefi

We appreciate your interest in contributing to StarkDefi! Here are some guidelines to help you get started.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Navigate to the project directory.

Codebase Structure

The codebase is organized into several directories, each serving a specific purpose:

  • src: Contains the source code for the smart contracts that power the StarkDefi platform.
  • tests: Contains the test cases for the smart contracts.
  • dex: Contains the source code for the decentralized exchange (DEX) contracts.

Development Environment

The project uses the Starknet network and Scarb for development. The dependencies and tools are specified in the Scarb.toml file.

Making Changes

  1. Create a new branch for your changes.
  2. Make your changes in the new branch. Please follow the existing coding style.
  3. Write tests for your changes in the tests directory.
  4. Run the tests to ensure they pass.

Submitting Changes

  1. Commit your changes with a descriptive commit message.
  2. Push your changes to your forked repository.
  3. Submit a pull request to the main repository.

Code Review

After you submit your pull request, it will be reviewed by the maintainers. They may ask for changes or improvements. Please be patient and responsive to their feedback.

Code of Conduct

Please be respectful and considerate of others. We want to foster a positive and inclusive community for everyone.

Thank you for your interest in contributing to StarkDefi!