Skip to content
This repository was archived by the owner on Apr 4, 2023. It is now read-only.

Commit f53bdc4

Browse files
committed
update the contributing.md
1 parent 0a301b5 commit f53bdc4

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Remember that there are many ways to contribute other than writing code: writing
3131

3232
## Development Workflow
3333

34+
We're using rust stable for the tests and clippy but rust nightly for the formatting of the code.
35+
3436
### Test
3537

3638
```bash
@@ -55,6 +57,28 @@ Don't forget to specify the `id` of the documents. Also, note that it supports J
5557
streaming: you can send them to the engine by using the `content-type:application/json` and
5658
`content-type:application/x-ndjson` headers respectively.
5759

60+
### Format
61+
62+
For your first run you'll need to run this command:
63+
64+
```bash
65+
touch benchmarks/benches/datasets_paths.rs
66+
```
67+
68+
Then you can format your code BUT you need to do it with rust-fmt.
69+
70+
```bash
71+
cargo +nightly fmt --all
72+
```
73+
74+
### Clippy
75+
76+
```bash
77+
cargo clippy
78+
```
79+
80+
81+
5882
## Git Guidelines
5983

6084
### Git Branches

0 commit comments

Comments
 (0)