Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

68 lines (44 loc) · 3.41 KB

Contributing to Malachite

First, thank you for your interest in improving Malachite!

There are multiple opportunities to contribute at any level. It doesn't matter if you are just getting started with Rust or are the most weathered expert, we can use your help.

No contribution is too small and all contributions are valued.

This document will help you get started. Do not let the document intimidate you. It should be considered as a guide to help you navigate the process.

The Telegram group is available for any concerns you may have that are not covered in this guide.

If you contribute to this project, your contributions will be made to the project under Apache 2.0 license.

Code of Conduct

The Malachite project adheres to the Rust Code of Conduct. This code of conduct describes the minimum behavior expected from all contributors.

Violations of this Code of Conduct can be reported by contacting the team at above mentioned contact email.

Ways to contribute

There are three ways you can contribute to Malachite:

  1. By opening an issue: For example, if you believe that you have uncovered a bug in Malachite, creating a new issue in the issue tracker is the way to report it.
  2. By adding context: Providing additional context to existing issues, such as screenshots and code snippets to help resolve issues.
  3. By resolving issues: Typically this is done in the form of either demonstrating that the issue reported is not a problem after all, or more often, by opening a pull request that fixes the underlying problem, in a concrete and reviewable manner.

Important

Please see CONTRIBUTING_CODE.md for detailed information about how to setup your environment, build Malachite, and run the test suite.

Scope of Contributions

At this time, we will not be accepting contributions that only fix spelling or grammatical errors in documentation, code or elsewhere.

Pull requests will only be accepted if they meet ALL of the following criteria:

  1. The submitter must be a core contributor to Malachite
    • OR the submitter must have been explicitly assigned to the issue that the PR addresses
  2. The PR must address an existing issue in our issue tracker
  3. The PR description must clearly reference the issue number it resolves and explain how it resolves the issue
  4. The PR must comply with all other contribution standards (code style, testing requirements, etc.)

Pull requests that do not meet these requirements will be closed without review.

If you are interested in contributing but are not a core contributor, please comment on an existing issue to request assignment before submitting a PR.

Getting Help

If you have reviewed existing documentation and still have questions, or you are having problems, you can get help by opening a discussion. This repository comes with a discussion board where we welcome everyone to ask and offer help.

Adapted from the CometBFT and Reth contributing guides.