Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (27 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) · 1.32 KB
Raw

CONTRIBUTING

We'd be glad for you to contribute to our source code and to make this project better!

Feel free to submit a pull request or an issue, but make sure to use the templates.

It is required to follow the Language Style rules.

Language Style

Files of different languages should be checked locally according to the following conventions.

Commits should be made after all checks pass or with additional clarifications.

Rust

Run cargo fmt(rustfmt) to format the code.

Run cargo clippy to lint the code.

Follow the official naming convention.

Building Rattan

Dependencies

We recommend developers to install the following dependencies for better testing and development experience:

sudo apt install ethtool iputils-ping iperf3 pkg-config m4 clang llvm libelf-dev libpcap-dev gcc-multilib libnftnl-dev libmnl-dev

Building

Rattan builds on stable Rust, if you want to build it from source, here are the steps to follow:

  1. Navigate to the directory of your choice

  2. Clone this repository with git.

    git clone https://github.com/stack-rs/rattan.git

  3. Navigate into the newly created rattan directory

  4. Run cargo build

The resulting binary can be found in rattan/target/debug/ under the name rattan.