From f53bdc43202859b81cbb56fbde64d54bf547cdb5 Mon Sep 17 00:00:00 2001 From: Tamo Date: Tue, 6 Dec 2022 17:41:05 +0100 Subject: [PATCH] update the contributing.md --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 83bfc5a5f..a9a0c95ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,8 @@ Remember that there are many ways to contribute other than writing code: writing ## Development Workflow +We're using rust stable for the tests and clippy but rust nightly for the formatting of the code. + ### Test ```bash @@ -55,6 +57,28 @@ Don't forget to specify the `id` of the documents. Also, note that it supports J streaming: you can send them to the engine by using the `content-type:application/json` and `content-type:application/x-ndjson` headers respectively. +### Format + +For your first run you'll need to run this command: + +```bash +touch benchmarks/benches/datasets_paths.rs +``` + +Then you can format your code BUT you need to do it with rust-fmt. + +```bash +cargo +nightly fmt --all +``` + +### Clippy + +```bash +cargo clippy +``` + + + ## Git Guidelines ### Git Branches