Skip to content

Latest commit

 

History

History
49 lines (43 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

49 lines (43 loc) · 1.96 KB
Raw

Contributing to Narwhal and Tusk

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes
  5. Make sure your code lints

Run the linter

The codebase uses the Clippy linter to ensure that common mistakes are caught. To install follow the instructions on the Clippy repository. We make use of a cargo alias (defined in .cargo/config) which sets some project-wide lints. To run the linter locally you can use the following command:

cargo xclippy

Run the formatter

To ensure that the codebase is following standard formatting properties, we use
Rustfmt. To run the formatter locally you can use the follow command:

cargo fmt --all

The above command will format and apply the changes directly. If you want to just see the formatter recommendations, just run with the --check property:

cargo fmt --all -- --check

Generating builders

The derive_builder crate has been used to auto-generate builders (following the builder design pattern) for structs. Instead of having to write (lots) of boilerplate code to create a builder, this is offered by the derive_builder and is the recommended way to create builders for this repo. Examples can be found within the repo and on the crate docs as well.

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

License

By contributing to Narwhal and Tusk, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.