Skip to content

Update CONTRIBUTING.md with issue on MacOs about Docker Environment setup #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 20, 2020
Merged

Update CONTRIBUTING.md with issue on MacOs about Docker Environment setup #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b903737
Update CONTRIBUTING.md
curquiza Jul 10, 2020
dbbe086
Update CONTRIBUTING.md
curquiza Jul 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down