Skip to content

Latest commit

 

History

History
140 lines (90 loc) · 3.83 KB

Contributing.md

File metadata and controls

140 lines (90 loc) · 3.83 KB
Raw

Contributing to Carbon Protocol V3

First off, thank you for considering contributing to Carbon Protocol V3! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

How Can I Contribute?

🌡️ Reporting Bugs

If you find a bug, please open an issue using the bug report template. Be sure to include a clear title and description, as much relevant information as possible, and a code sample or screenshot if applicable.

📝 Requesting Features

If you have an idea for a new feature, please submit a feature request using the feature request template. Include a clear and concise description of the feature, why it would be useful, and any additional context. You can also contact us through Discord or Telegram to discuss about it.

⛏️ Submitting Pull Requests

  1. Choose an issue: Pick an unassigned issue and ask for more information if needed via Telegram or Discord.
  2. Fork the repository: Click the "Fork" button on the top right of the repository page and create a new branch dedicated to the issue.
  3. Code your changes: Implement your feature or fix the bug. Follow the project's coding style and commit message principles.
  4. Test your changes: Ensure that all tests pass and your changes do not break existing functionality.
  5. Submit your changes: Push your changes and open a new pull request with a clear description of your changes and link to any relevant issues.

📦 Project Setup

Requirements

We recommend installing dependencies using asdf:

asdf plugin add scarb
asdf install scarb 2.6.0
asdf plugin add starknet-foundry
asdf install starknet-foundry 0.26.0

Compile

To compile the project, run:

scarb build

Set you env

Follow the .env.template

source .env

Code Style

To format the code, run:

scarb fmt

Testing

To run tests (using Starknet-Foundry), use:

scarb test

To run a specific test:

scarb test <name_of_the_test>

Devnet

To generata an accound see : this page

cargo install starknet-devnet

To run a new node

starknet-devnet

Fork existing chain with flag

--fork-network $FORK_URL

for further options

starknet-devnet --help

Deploy

To deploy (on testnet/mainnet/devnet), use:

  1. Check available contract
bash scripts/declare.sh

2 Declare contract -> it gives you a class_hash

bash scripts/declare.sh <contract_name>
  1. Deploy contracts If you want to simulate the whole infra, please deploy in this order: mock_stable, project, minter, offsetter
bash scripts/deploy_<name>.sh <ClASS_HASH> <...ARGS>

Guidelines

  • All tests should be placed in the tests/ folder.
  • Tests should be organized according to the tested file and function.
  • Refer to existing tests for coding style and structure.
  • Use utility functions from tests/tests_lib.cairo to set up your tests and avoid redundancy (especially default_setup_and_deploy and buy_utils).

License

By contributing to Carbon Protocol V3, you agree that your contributions will be licensed under the License used.

Thank You

Thank you for your interest in contributing to Carbon Protocol V3! We look forward to building something great together.