Skip to content

Commit

Permalink
Be more explicit about the code style of the project
Browse files Browse the repository at this point in the history
Signed-off-by: Tomás González <[email protected]>
  • Loading branch information
tgonzalezorlandoarm committed Sep 18, 2023
1 parent 3425567 commit 8901a89
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
7 changes: 7 additions & 0 deletions src/contributing/pr_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ Buffers should be zeroed out after usage if they contain any sensitive data.
Logs should not contain sensitive data, and should only present detailed data and error information
(such as stack traces) if configured so.

Parsec should follow the [Rust Style
Guide](https://doc.rust-lang.org/nightly/style-guide/#rust-style-guide) and [Rust official
lints](https://rust-lang.github.io/rust-clippy/master/index.html), both of which are enforced by the
tools mentioned in the [How to test
Parsec](https://parallaxsecond.github.io/parsec-book/parsec_service/tests/index.html) section, on
static checks.

New functionality is properly tested.

## Threat model
Expand Down
7 changes: 4 additions & 3 deletions src/parsec_service/tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,10 @@ multithreaded client. Valid requests are sent intermittently so as to check that
still up and working correctly.

The `ci.sh` script executes all tests and is used on the CI.
[`rustfmt`](https://github.com/rust-lang/rustfmt) and
[`clippy`](https://github.com/rust-lang/rust-clippy) are needed for code formatting and static
checks.

Parsec's code style is enforced by [`rustfmt`](https://github.com/rust-lang/rustfmt) and
[`clippy`](https://github.com/rust-lang/rust-clippy), which are needed for code formatting and
static lint checks respectively. A documentation style is also enforced by `cargo test --doc`.

You can see a (partial) code coverage figure [here](https://app.codecov.io/gh/parallaxsecond/parsec)
- partial because only a subset of the tests can be run with the code coverage instrumentation
Expand Down

0 comments on commit 8901a89

Please sign in to comment.