Skip to content

Commit a30428f

Browse files
committed
docs: improve the wording and details of the contributing docs
* rename CONTRIBUTOR -> CONTRIBUTING * document cargo commands for testing / building all crates in the workspace
1 parent 5f24196 commit a30428f

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

CONTRIBUTOR.md renamed to CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ or open a PR from your own fork to start a discussion ☺️..
88

99
## 🪝 Hooks 🪝
1010

11-
We recommend using the hooks while developing in this repository.
12-
The hooks manager is a python package which needs installing locally.
11+
It is recommended to use git hooks while developing in this repository.
12+
The hooks manager (pre-commit) is a python package which needs installing locally.
1313
The best way to do this is via a virtual environment.
1414

1515
```shell
@@ -22,18 +22,22 @@ The best way to do this is via a virtual environment.
2222
## 🧱 Building 🧱
2323

2424
To build, simply follow the usual cargo flow.
25+
2526
```shell
26-
> cargo build --all-features
27+
> cargo build --all --all-features
2728
```
2829

2930
## Tests
3031

31-
The project currently has a good unit tests coverage,
32+
The project currently has a unit test, and documentation test coverage,
3233
but no integration test coverage yet.
33-
To run the tests, follow the usual cargo flow.
34+
To run all the tests, follow the usual cargo flow.
35+
36+
When adding new features please try to cover the new code
37+
with appropriate unit test cases.
3438

3539
```shell
36-
> cargo test --all-features
40+
> cargo test --all --all-features
3741
```
3842

3943
## 🌍 A Tour of midi2 🌍

0 commit comments

Comments
 (0)