Skip to content

Commit 8547d75

Browse files
authored
[docs] Add instructions to fork repo to IDE setup page (#599)
1 parent f02bc10 commit 8547d75

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

website/community/dev/ide-setup.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,24 @@ that has a bug or is not properly set up.
3434
Using the included [Maven Wrapper](https://maven.apache.org/wrapper/) by replacing `mvn` with `./mvnw` ensures that the correct Maven version is used.
3535
:::
3636

37-
## Preparation
37+
## Preparation: Fork and Clone the Fluss Repository
3838

39-
To get started, please first checkout the Fluss sources from our
40-
[repository](https://github.com/alibaba/fluss),
41-
e.g.
39+
Fluss uses [git](http://git-scm.com/) for version control.
40+
The Git repository is mirrored to [GitHub](https://github.com/alibaba/fluss/).
41+
42+
The common way to merge code changes on GitHub is to fork the repository (creating a copy of the repository to your personal GitHub account so you can modify the source code) and issue a pull request.
43+
44+
1. To fork the Fluss repository, log in with your GitHub account. If you do not have one yet, [sign up for free](https://github.com/signup). Then, click the `[Fork]` button on the upper right of the [Fluss repository](https://github.com/alibaba/fluss/).
45+
2. Clone the _forked_ version of the repository over HTTPs or SSH. SSH is recommended but needs to be [explicitly configured](https://docs.github.com/en/authentication/connecting-to-github-with-ssh).
46+
47+
```bash
48+
# Clone using HTTPs
49+
git clone https://github.com/<your-user-name>/fluss.git
50+
```
4251

4352
```bash
44-
git clone [email protected]:alibaba/fluss.git
53+
# Clone using SSH
54+
git clone [email protected]:<your-user-name>/fluss.git
4555
```
4656

4757
## IntelliJ IDEA

0 commit comments

Comments
 (0)