From b9037372bc51b3221b2de7cf436dbef0a3ec5147 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Fri, 10 Jul 2020 17:07:01 +0200 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 69095fae..9eb3ef26 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,53 +29,55 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ## Development Workflow -### Using the Docker Environment +### Using Composer #### Setup -To start and build your Docker environment, just execute the next command in a terminal: +Install the dependencies: ```sh -$ docker-compose up -d +$ composer install ``` -Be sure no other MeiliSearch instance is currently running on your machine. - #### Tests and Linter Each Pull Request should pass the tests, and the linter to be accepted. ```sh # Tests -$ docker-compose exec -e MEILISEARCH_URL=http://meilisearch:7700 php composer test:unit +$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics +$ composer test:unit # Linter -$ docker-compose exec php composer lint:check +$ composer lint:check # Linter (with auto-fix) -$ docker-compose exec php composer lint:fix +$ composer lint:check ``` -### Using Composer +### Using the Docker Environment + +These commands do not work on MacOS, see [this issue](https://github.com/meilisearch/meilisearch-symfony/).
#### Setup -Install the dependencies: +To start and build your Docker environment, just execute the next command in a terminal: ```sh -$ composer install +$ docker-compose up -d ``` +Be sure no other MeiliSearch instance is currently running on your machine. + #### Tests and Linter Each Pull Request should pass the tests, and the linter to be accepted. ```sh # Tests -$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics -$ composer test:unit +$ docker-compose exec -e MEILISEARCH_URL=http://meilisearch:7700 php composer test:unit # Linter -$ composer lint:check +$ docker-compose exec php composer lint:check # Linter (with auto-fix) -$ composer lint:check +$ docker-compose exec php composer lint:fix ``` ### Release Process From dbbe086005ee31d447ae5e280d434da39e7e75ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9mentine=20Urquizar?= Date: Fri, 10 Jul 2020 17:07:53 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9eb3ef26..f6e0b4bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,7 +55,7 @@ $ composer lint:check ### Using the Docker Environment -These commands do not work on MacOS, see [this issue](https://github.com/meilisearch/meilisearch-symfony/).
+These commands do not work on MacOS, see [this issue](https://github.com/meilisearch/meilisearch-symfony/). #### Setup