[docs] Update docs to clone Venice repo using ssh and add instruction…

…s on how to disable wildcard imports
linkedin · Dec 13, 2024 · 60333c9 · 60333c9
1 parent a15f3c5
commit 60333c9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/docs/dev_guide/how_to/code_style.png b/docs/dev_guide/how_to/code_style.png
diff --git a/docs/dev_guide/how_to/workspace_setup.md b/docs/dev_guide/how_to/workspace_setup.md
@@ -15,9 +15,9 @@ Fork the Venice repo at [https://github.com/linkedin/venice](https://github.com/
 
 ## Setting up the repository locally
 ```shell
-git clone https://github.com/${githubUsername}/venice.git
+git clone git@github.com:${githubUsername}/venice.git
 cd venice
-git remote add upstream https://github.com/linkedin/venice.git
+git remote add upstream git@github.com:linkedin/venice.git
 git fetch upstream
 ```
 
@@ -39,6 +39,13 @@ To set up IntelliJ, run:
 ./gradlew idea
 ```
 
+### Disable wildcard imports
+1. In IntelliJ, click the gear icon in the top right and select settings.
+2. Go to Editor -> Code Style -> Java and selects Imports from the tabs.
+3. Next to Scheme, select the gear icon and hit duplicate
+4. Use these settings:
+![code_style.png](code_style.png)
+
 ## Setting up your system
 ### Set the maximum number of open files limit
 There are many resources on the web for updating the limits of maximum number of open files for each operating system.