Skip to content

Commit 9b3a303

Browse files
Merge pull request #375 from alexislefebvre/doc-contributing-mac-arm
doc: add note about contributing with Mac ARM
2 parents b23da14 + e4e491f commit 9b3a303

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

doc/contributing.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ This is for people who want to contribute to the project.
44
## How to get started
55

66
First of all, you need to fork the repository and clone it locally.
7-
After that, we've prepared a docker setup to help you get started quickly.
7+
After that, we've prepared a Docker setup to help you get started quickly.
88

9-
Install docker and docker-compose on your machine, then run the following commands:
9+
Install `docker` and `docker compose` (or the older version `docker-compose`) on your machine, then run the following commands:
10+
11+
> [!TIP]
12+
> If you use a Mac with ARM architecture (M1, M2, etc.), you may need to [modify the `docker-compose.yml` file](https://github.com/bitnami/containers/issues/40947#issuecomment-1927013148). Please don’t commit the changes to this file, keep them on your local environment.
1013
1114
```bash
1215
docker-compose up --detach

0 commit comments

Comments
 (0)