From e4e491fff4a3bc184ceba292be9ae6a99940fcf6 Mon Sep 17 00:00:00 2001 From: Alexis Lefebvre Date: Fri, 16 Jan 2026 17:43:41 +0100 Subject: [PATCH] doc: add note about contributing with Mac ARM --- doc/contributing.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/contributing.md b/doc/contributing.md index cbff7323..0a1b5fe9 100644 --- a/doc/contributing.md +++ b/doc/contributing.md @@ -4,9 +4,12 @@ This is for people who want to contribute to the project. ## How to get started First of all, you need to fork the repository and clone it locally. -After that, we've prepared a docker setup to help you get started quickly. +After that, we've prepared a Docker setup to help you get started quickly. -Install docker and docker-compose on your machine, then run the following commands: +Install `docker` and `docker compose` (or the older version `docker-compose`) on your machine, then run the following commands: + +> [!TIP] +> 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. ```bash docker-compose up --detach