Skip to content

Commit 83c213a

Browse files
committed
Move down the Docker tips on the CONTRIBUTING.md
- Reason: currently this is not a standard way to setup the local env among all the repos of the project.
1 parent 5e2cae2 commit 83c213a

File tree

1 file changed

+15
-26
lines changed

1 file changed

+15
-26
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,6 @@ 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-
5444
### Setup <!-- omit in toc -->
5545

5646
```bash
@@ -61,22 +51,10 @@ bundle install
6151

6252
Each PR should pass the tests to be accepted.
6353

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:
7954
```bash
55+
# Tests
56+
curl -L https://install.meilisearch.com | sh # download MeiliSearch
57+
./meilisearch --master-key=masterKey --no-analytics=true # run MeiliSearch
8058
bundle exec rspec
8159
```
8260

@@ -99,7 +77,6 @@ Each PR should pass the linter to be accepted.
9977
```bash
10078
# Check the linter errors
10179
bundle exec rubocop lib/ spec/
102-
10380
# Auto-correct the linter errors
10481
bundle exec rubocop -a lib/ spec/
10582
```
@@ -112,6 +89,18 @@ To update it, run the following command:
11289
bundle exec rubocop --auto-gen-config
11390
```
11491

92+
### Docker <!-- omit in toc -->
93+
If you have Docker/Docker Composer installed, you can alternatively setup your local development environment following the steps below.
94+
95+
```bash
96+
# Create/run the containers
97+
docker compose up -d
98+
# Run the bash of meilisearch_ruby
99+
docker compose exec meilisearch_ruby bash
100+
# Then now you can run `bundle install`, tests, linter, code etc.
101+
```
102+
103+
115104
### Want to debug? <!-- omit in toc -->
116105

117106
You can use the [`byebug` gem](https://github.com/deivid-rodriguez/byebug).

0 commit comments

Comments
 (0)