Skip to content

Commit bf7b714

Browse files
committed
Add static analyzer to doc
1 parent 3ac6598 commit bf7b714

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ Take a look to the conventions established by existing code:
2525
* Every module should provide a Rust doctest, a brief test embedded with the documentation that explains how to use the procedure implemented.
2626
* 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.
2727
* 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.
28+
* a nice overview of the codebase is given by [static analyzer](https://mozilla.github.io/rust-code-analysis/metrics.html):
29+
```
30+
$ cargo install rust-code-analysis-cli
31+
$ rust-code-analysis-cli -m -O json -o . -p src/ --pr
32+
```
2833

2934
## Issue Report Process
3035

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ src.dot
2626
out.svg
2727

2828
FlameGraph/
29-
out.stacks
29+
out.stacks
30+
*.json

0 commit comments

Comments
 (0)