From 988cab5f8eb2b836a2956dce04343d68b2deeafa Mon Sep 17 00:00:00 2001 From: Rob Russell Date: Tue, 2 Apr 2024 20:01:50 -0700 Subject: [PATCH] Add instruction to clone with depth 1 --- .github/CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1830d1c6..08c445d7 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -21,6 +21,11 @@ Image paths should be relative so they display correctly in a local preview. The site is build with [MkDocs](https://www.mkdocs.org/) and the [readthedocs](https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs) theme. + +Clone the git repo. The `--depth 1` flag will clone just the most recent revision. + + git clone --depth 1 https://github.com/nasa-jpl/open-source-rover.git + You may build the site locally to preview your changes. python -m venv .venv