Skip to content

docs: document Apple Silicon contributor setup in CONTRIBUTING.rst #4663

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

Open
thedrishtigupta wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

docs: document Apple Silicon contributor setup in CONTRIBUTING.rst #4663

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca7a0ef
docs: add Apple Silicon warning to CONTRIBUTING.rst
thedrishtigupta Jan 4, 2026
08450c5
docs: simplify Apple Silicon warning per maintainer feedback
thedrishtigupta Jan 9, 2026
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
15 changes: 15 additions & 0 deletions CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,21 @@ To set up ScanCode for local development:
libraries (from the `thirdparty/ directory`), setup the paths, etc.
See https://virtualenv.pypa.io/en/latest/ for more details.

.. warning::

**Apple Silicon (M1/M2/M3/M4) users**

Due to missing ARM64 wheels for some native dependencies, the contributor
setup may fail when using ARM-native Python.

Use an x86_64 Python installation under Rosetta and configure ScanCode
to use it explicitly before running ``./configure --dev``.

See the Homebrew and Python documentation for installing x86_64 Python
under Rosetta, and issue #3205 for more context on Apple Silicon
compatibility.


Run this command to configure ScanCode::

./configure --dev
Expand Down
Loading