From bf7b714126b47808947b61f449f3872bc15dcfab Mon Sep 17 00:00:00 2001 From: "Lorenzo (Mec-iS)" Date: Mon, 7 Nov 2022 18:16:13 +0000 Subject: [PATCH] Add static analyzer to doc --- .github/CONTRIBUTING.md | 5 +++++ .gitignore | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c09dfa7..48bce72 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -25,6 +25,11 @@ Take a look to the conventions established by existing code: * Every module should provide a Rust doctest, a brief test embedded with the documentation that explains how to use the procedure implemented. * Every module should provide comprehensive tests at the end, in its `mod tests {}` sub-module. These tests can be flagged or not with configuration flags to allow WebAssembly target. * Run `cargo doc --no-deps --open` and read the generated documentation in the browser to be sure that your changes reflects in the documentation and new code is documented. +* a nice overview of the codebase is given by [static analyzer](https://mozilla.github.io/rust-code-analysis/metrics.html): +``` +$ cargo install rust-code-analysis-cli +$ rust-code-analysis-cli -m -O json -o . -p src/ --pr +``` ## Issue Report Process diff --git a/.gitignore b/.gitignore index 9c0651c..e2976f7 100644 --- a/.gitignore +++ b/.gitignore @@ -26,4 +26,5 @@ src.dot out.svg FlameGraph/ -out.stacks \ No newline at end of file +out.stacks +*.json \ No newline at end of file