Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 2.23 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 2.23 KB

Contributing to Mango

Thank you for your interest in contributing to Mango. We welcome all contributions that help improve the project. This guide outlines how you can get involved and key coding conventions to follow.

Getting Started

  1. Fork & Clone – Fork the repository and clone it locally.
  2. Set Up – Install dependencies and configure your environment using the Developer Guide.
  3. Choose an Issue – Check the issue tracker for open tasks or propose your own.
  4. Work on Changes – Create a new branch for your contribution.
  5. Commit & Push – Follow best practices for commit messages and push your branch.
  6. Submit a Pull Request (PR) – Open a PR with a clear description of your changes.

Code Quality & Conventions

Rust

  • Use rustfmt for formatting and cargo clippy for linting.
  • Handle errors gracefully using Result and Option.
  • Keep the code safe and efficient, adhering to Rust’s memory safety features.

Move

  • Use explicit types where necessary and keep code readable.
  • Ensure safety and clarity, especially in smart contract logic.
  • Write tests and provide documentation where applicable.

Contribution Guidelines

  • Follow Coding Standards – Stick to the Rust and Move best practices outlined above.
  • Keep PRs Focused – One feature or fix per PR to make reviews easier.
  • Respect Feedback – Be open to code reviews and constructive criticism.
  • Security & Privacy – Avoid exposing sensitive data in commits or discussions.

Reporting Issues

If you find a bug or have a feature request:

  • Check if it’s already reported in our Discord.
  • If not, open a new issue with a clear title and detailed description.
  • Provide steps to reproduce, expected behavior, and screenshots if applicable.

Community & Support

Join the discussion on Discord or reach out via Telegram for any questions.

By contributing, you agree to follow the Code of Conduct. We appreciate your support in making Mango better.