Add static analyzer to doc

This commit is contained in:
Lorenzo (Mec-iS)
2022-11-07 18:16:13 +00:00
parent 3ac6598951
commit bf7b714126
2 changed files with 7 additions and 1 deletions
+5
View File
@@ -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
+2 -1
View File
@@ -26,4 +26,5 @@ src.dot
out.svg
FlameGraph/
out.stacks
out.stacks
*.json