From b4ff341d1150a252c19f34d2b3d9150750d2af53 Mon Sep 17 00:00:00 2001 From: AhmetAhunbayAWS Date: Fri, 14 Jun 2024 14:38:01 -0700 Subject: [PATCH] docs: CONTRIBUTING.md troubleshooting section addition (#5322) Co-authored-by: Caleb Pollman --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9bc7e04116c..b47982f0534 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,7 @@ You should open an issue to discuss your pull request, unless it's a trivial cha ### Troubleshooting +**Apple Silicon:** If using an M1 (or more recent) Macbook and you get the following error message regarding installation of `canvas`: ```bash @@ -65,6 +66,18 @@ gyp: Call to 'pkg-config pixman-1 --libs' returned exit status 127 while in bind See the [canvas docs](https://github.com/Automattic/node-canvas#compiling) to install required dependencies for local docs development. +**Python >= 3.12:** +If you are using Python 3.12 or greater and you get the following error message regarding installation of `canvas`: + +```bash +error /Users/USERNAME/amplify-ui/node_modules/canvas: Command failed. +Exit code: 1 +... +ModuleNotFoundError: No module named 'distutils' +``` + +See the [setuptools](https://pypi.org/project/setuptools/) installation website. Setuptools serves as a [recommended](https://docs.python.org/3.10/library/distutils.html) alternative to distutils. + ## Project Structure `amplify-ui` is a monorepo that contains the following workspaces: