Skip to content

Commit add86f5

Browse files
committed
Update the CONTRIBUTING page with tips about the Docker containers usage for local development
1 parent 14cc933 commit add86f5

File tree

1 file changed

+26
-3
lines changed

1 file changed

+26
-3
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,16 @@ It's [Hacktoberfest month](https://blog.meilisearch.com/contribute-hacktoberfest
4141

4242
## Development Workflow
4343

44+
### (optional) Docker <!-- omit in toc -->
45+
If you have Docker/Docker Composer installed, it's preferable to use it over installing basic dependencies one by one.
46+
```bash
47+
# Create/run the containers
48+
docker compose up -d
49+
50+
# Run the bash of meilisearch_ruby
51+
docker compose exec meilisearch_ruby bash
52+
```
53+
4454
### Setup <!-- omit in toc -->
4555

4656
```bash
@@ -51,10 +61,22 @@ bundle install
5161

5262
Each PR should pass the tests to be accepted.
5363

64+
#### Download and run MeiliSearch <!-- omit in toc -->
65+
> **NOTE**: _Ignore these steps if you're running the project using the Docker Compose file._
66+
67+
68+
```bash
69+
# Download MeiliSearch
70+
curl -L https://install.meilisearch.com | sh
71+
72+
# Run MeiliSearch:
73+
./meilisearch --master-key=masterKey --no-analytics=true
74+
```
75+
76+
#### Run tests <!-- omit in toc -->
77+
78+
Run all tests:
5479
```bash
55-
# Tests
56-
curl -L https://install.meilisearch.com | sh # download MeiliSearch
57-
./meilisearch --master-key=masterKey --no-analytics=true # run MeiliSearch
5880
bundle exec rspec
5981
```
6082

@@ -77,6 +99,7 @@ Each PR should pass the linter to be accepted.
7799
```bash
78100
# Check the linter errors
79101
bundle exec rubocop lib/ spec/
102+
80103
# Auto-correct the linter errors
81104
bundle exec rubocop -a lib/ spec/
82105
```

0 commit comments

Comments
 (0)