docs: add Apple Silicon setup note to CONTRIBUTING #4665
Conversation
There was a problem hiding this comment.
Thanks @gopu0106, please see comments for your consideration
It also seems like this PR is exactly same to #4663 and was opened after the other one was opened. While it is fine for two contributors to work on something, you should try to collaborate before opening another PR, and if you use parts from another PR, you should credit them.
|
|
||
| .. code-block:: bash | ||
| arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" |
There was a problem hiding this comment.
IMHO we should not include installation instructions for other packages directly (as it might change and our docs will become outdated, might have other requirements/prerequisites). Instead use a link to their installation docs
| Some native dependencies do not provide ARM64 wheels. Using ARM64 Python | ||
| (e.g., Homebrew Python on Apple Silicon) may cause ``./configure --dev`` | ||
| to fail. A tested workaround is to use x86_64 Python under Rosetta. | ||
| See issue #3205 for additional context. |
There was a problem hiding this comment.
If you are including a reference to an issue, why not also link this?
|
Thanks for pointing this out. I can update the references to include proper links and remove the inline install commands in favor of linking to the official docs. |
2 participants
This PR adds a short Apple Silicon (M1/M2/M3/M4) note to CONTRIBUTING.rst
to warn contributors about ARM64 dependency limitations and document a
tested x86_64/Rosetta workaround.
Fixes #4650.