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

Commit ee10cb8

Browse files
bors[bot]irevoire
andauthored
Merge #726
726: Update the contributing.md r=curquiza a=irevoire Co-authored-by: Tamo <[email protected]>
2 parents 0a301b5 + 2507438 commit ee10cb8

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 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 a stable version of Rust for the tests and Clippy but the nightly version of Rust for the formatting of the code.
35+
3436
### Test
3537

3638
```bash
@@ -55,6 +57,34 @@ 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+
If you have not installed the rust nightly version yet here is how to do it:
70+
71+
```bash
72+
rustup toolchain install nightly
73+
```
74+
75+
You can read more about it here: https://rust-lang.github.io/rustup/concepts/channels.html
76+
77+
And finally, to format your code you can run:
78+
79+
```bash
80+
cargo +nightly fmt --all
81+
```
82+
83+
### Clippy
84+
85+
```bash
86+
cargo clippy
87+
```
5888
## Git Guidelines
5989

6090
### Git Branches

0 commit comments

Comments
 (0)