From 7def4f5f7e006c42f4791e96bd5066e9f6f48bec Mon Sep 17 00:00:00 2001 From: bartziengs Date: Mon, 16 Mar 2020 16:34:04 +0100 Subject: [PATCH] Link post about externalization in CONTRIBUTING.md (#1244) --- CONTRIBUTING.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ccc6b25f8..000761dc10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,9 +32,19 @@ If you port openpilot to a substantially new car brand, see this more generic [B ## Pull Requests -Pull requests should be against the master branch. Before running master on in-car hardware, you'll need to run +Pull requests should be against the master branch. Before running master on in-car hardware, you'll need to clone the submodules too. That can be done by recursively cloning the repository: +``` +git clone https://github.com/commaai/openpilot.git --recursive +``` +Or alternatively, when on the master branch: ``` git submodule init git submodule update ``` -in order to pull down the submodules, such as `panda` and `opendbc`. +The reasons for having submodules on a dedicated repository and our new development philosophy can be found in our [post about externalization](https://medium.com/@comma_ai/a-2020-theme-externalization-13b33326d8b3). +Modules that are in seperate repositories include: +* apks +* cereal +* laika +* opendbc +* panda \ No newline at end of file