snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2024-11-30 17:14:59 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

update the contributing.md

Browse Source
This commit is contained in:
Tamo 2022-12-06 17:41:05 +01:00
parent 0a301b5f88
commit f53bdc4320
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -31,6 +31,8 @@ Remember that there are many ways to contribute other than writing code: writing
## Development Workflow ## Development Workflow
We're using rust stable for the tests and clippy but rust nightly for the formatting of the code.
### Test ### Test
```bash ```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 streaming: you can send them to the engine by using the `content-type:application/json` and
`content-type:application/x-ndjson` headers respectively. `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 Guidelines
### Git Branches ### Git Branches