Skip to content

Commit 2af0fa9

Browse files
authored
[docs] Update docs to clone Venice repo using ssh and add instructions on how to disable wildcard imports (#1392)
I'm changing the instructions to clone the Venice repo using ssh instead of https, as https can cause authentication issues when trying to perform a hotfix. I'm also adding instructions on how to disable wildcard imports as this is not a code style the team follows.
1 parent a15f3c5 commit 2af0fa9

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/dev_guide/how_to/workspace_setup.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Fork the Venice repo at [https://github.com/linkedin/venice](https://github.com/
1515

1616
## Setting up the repository locally
1717
```shell
18-
git clone https://github.com/${githubUsername}/venice.git
18+
git clone git@github.com:${githubUsername}/venice.git
1919
cd venice
20-
git remote add upstream https://github.com/linkedin/venice.git
20+
git remote add upstream git@github.com:linkedin/venice.git
2121
git fetch upstream
2222
```
2323

@@ -39,6 +39,14 @@ To set up IntelliJ, run:
3939
./gradlew idea
4040
```
4141

42+
### Disable wildcard imports
43+
1. In IntelliJ, click the gear icon in the top right and select settings
44+
2. Go to Editor -> Code Style -> Java and select Imports from the tabs
45+
3. Next to Scheme, select the gear icon and hit duplicate
46+
4. Only check `Use single class import`
47+
5. Set `Class count to use import with *` to 1000
48+
6. Set `Names count to use static import with *` to 1000
49+
4250
## Setting up your system
4351
### Set the maximum number of open files limit
4452
There are many resources on the web for updating the limits of maximum number of open files for each operating system.

0 commit comments

Comments
 (0)