Skip to content

doc: add note about contributing with Mac ARM #375

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
alexisLefebvre merged 1 commit into from
Jan 16, 2026
+5 −2
Merged

doc: add note about contributing with Mac ARM #375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions doc/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading