Skip to content

Commit

Permalink
docs: CONTRIBUTING.md troubleshooting section addition (#5322)
Browse files Browse the repository at this point in the history
Co-authored-by: Caleb Pollman <[email protected]>
  • Loading branch information
AhmetAhunbayAWS and calebpollman authored Jun 14, 2024
1 parent 05df300 commit b4ff341
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down

0 comments on commit b4ff341

Please sign in to comment.