Skip to content

Commit c23d6a4

Browse files
authored
Update CONTRIBUTING.md with issue on MacOs about Docker Environment setup (#16)
* Update CONTRIBUTING.md * Update CONTRIBUTING.md
1 parent 4187a75 commit c23d6a4

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -29,53 +29,55 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
2929

3030
## Development Workflow
3131

32-
### Using the Docker Environment
32+
### Using Composer
3333

3434
#### Setup
3535

36-
To start and build your Docker environment, just execute the next command in a terminal:
36+
Install the dependencies:
3737

3838
```sh
39-
$ docker-compose up -d
39+
$ composer install
4040
```
4141

42-
Be sure no other MeiliSearch instance is currently running on your machine.
43-
4442
#### Tests and Linter
4543

4644
Each Pull Request should pass the tests, and the linter to be accepted.
4745

4846
```sh
4947
# Tests
50-
$ docker-compose exec -e MEILISEARCH_URL=http://meilisearch:7700 php composer test:unit
48+
$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics
49+
$ composer test:unit
5150
# Linter
52-
$ docker-compose exec php composer lint:check
51+
$ composer lint:check
5352
# Linter (with auto-fix)
54-
$ docker-compose exec php composer lint:fix
53+
$ composer lint:check
5554
```
5655

57-
### Using Composer
56+
### Using the Docker Environment
57+
58+
These commands do not work on MacOS, see [this issue](https://github.com/meilisearch/meilisearch-symfony/).
5859

5960
#### Setup
6061

61-
Install the dependencies:
62+
To start and build your Docker environment, just execute the next command in a terminal:
6263

6364
```sh
64-
$ composer install
65+
$ docker-compose up -d
6566
```
6667

68+
Be sure no other MeiliSearch instance is currently running on your machine.
69+
6770
#### Tests and Linter
6871

6972
Each Pull Request should pass the tests, and the linter to be accepted.
7073

7174
```sh
7275
# Tests
73-
$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics
74-
$ composer test:unit
76+
$ docker-compose exec -e MEILISEARCH_URL=http://meilisearch:7700 php composer test:unit
7577
# Linter
76-
$ composer lint:check
78+
$ docker-compose exec php composer lint:check
7779
# Linter (with auto-fix)
78-
$ composer lint:check
80+
$ docker-compose exec php composer lint:fix
7981
```
8082

8183
### Release Process

0 commit comments

Comments
 (0)