CONTRIBUTING.md

The Algorithms: Rust

This project aims at showcasing common algorithms implemented in Rust, with an accent on idiomatic code and genericity.

Project structure

The project is organized as follows:

src/

• my_algo_category/
  • mod.rs
  • my_algorithm.rs
  • some_other_algorithm.rs
• some_other_algo_category/
  • ...

mod.rs contains the export:

mod my_algorithm;

pub use self::my_algorithm::my_algorithm;

my_algorithm.rs contains your algorithm and the related tests:

pub fn my_algorithm() {
    // ...
}

#[cfg(test)]
mod tests {
    #[test]
    fn my_test() {
        // ...
    }
}

Before submitting your PR

Do not use acronyms: DFS should be depth_first_search.

Make sure you run

• cargo test
• cargo fmt
• cargo clippy --all -- -D warnings

And that's about it !