Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 1.77 KB

Contributing to Merkle Tree Builder

Thank you for considering contributing to the Merkle Tree Builder! Contributions are what make the open-source community such a wonderful place to learn and grow.

How Can I Contribute?

🌡️ Reporting Bugs

To report a bug, open an issue using the bug report template. Include a clear description, steps to reproduce, and any relevant screenshots or logs.

📝 Requesting Features

Have a new idea? Submit a feature request using the feature request template.

⛏️ Submitting Pull Requests

  1. Choose an issue: Pick an open issue and ask for clarification if needed.
  2. Fork the repository: Create a new branch for your feature or fix.
  3. Code your changes: Follow the project's coding style.
  4. Test your changes: Ensure tests pass.
  5. Submit your changes: Open a pull request and link it to the issue.

📦 Project Setup

Rust

  • Install Rust: rustup
  • Run cargo build to compile the project.
  • Run cargo test to verify functionality.

Cairo

  • Install Scarb: scarb
  • Run scarb build to compile.
  • Run scarb test to test.

Guidelines

  • Write tests for all new features.
  • Organize tests in tests/ folder.
  • Follow Rust and Cairo formatting guidelines using cargo fmt and scarb fmt.

License

By contributing, you agree that your contributions will be licensed under the project license.

Thank you for your time and effort in making Merkle Tree Builder better!