Skip to content

Commit 40d9fdf

Browse files
committed
Add a tip on code formatting in the "Contributing" docs
Also remove the warning on arm64 Docker building as it's now included in the Dockerfile Signed-off-by: Thomas Druez <tdruez@nexb.com>
1 parent 7fde638 commit 40d9fdf

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

docs/contributing.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@ For more established contributors, you can contribute to the codebase in several
5858
and :ref:`faq` to confirm whether a given issue or a question has previously been
5959
discussed.
6060

61+
.. tip::
62+
Cleanup your code before submitting changes using the ``make valid``
63+
command to ensure the proper code format and imports order.
64+
6165
Documentation Improvements
6266
^^^^^^^^^^^^^^^^^^^^^^^^^^
6367

docs/installation.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,6 @@ create an **environment file**, and **build the Docker image**::
4242
make envfile
4343
docker-compose build
4444

45-
.. warning::
46-
If your host machine is based on Apple Silicon or another ARM64 architecture,
47-
you need to force the platform to ``linux/amd64`` at build time using::
48-
49-
DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose build
50-
5145
.. note::
5246
You need to rebuild the image whenever ScanCode.io's source code has been
5347
modified or updated.

0 commit comments

Comments
 (0)