You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/community/dev/ide-setup.md
+58-16Lines changed: 58 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ sidebar_label: IDE Setup
19
19
limitations under the License.
20
20
-->
21
21
22
-
# Import Fluss into an IDE
22
+
# IDE Setup
23
23
24
24
The sections below describe how to import the Fluss project into an IDE
25
25
for the development of Fluss itself.
@@ -84,21 +84,21 @@ adding a Copyright profile:
84
84
2. Add a new profile and name it "Alibaba".
85
85
3. Add the following text as the license text:
86
86
87
-
```
88
-
Copyright (c) 2025 Alibaba Group Holding Ltd.
89
-
90
-
Licensed under the Apache License, Version 2.0 (the "License");
91
-
you may not use this file except in compliance with the License.
92
-
You may obtain a copy of the License at
93
-
94
-
http://www.apache.org/licenses/LICENSE-2.0
95
-
96
-
Unless required by applicable law or agreed to in writing, software
97
-
distributed under the License is distributed on an "AS IS" BASIS,
98
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
99
-
See the License for the specific language governing permissions and
100
-
limitations under the License.
101
-
```
87
+
```text
88
+
Copyright (c) 2025 Alibaba Group Holding Ltd.
89
+
90
+
Licensed under the Apache License, Version 2.0 (the "License");
91
+
you may not use this file except in compliance with the License.
92
+
You may obtain a copy of the License at
93
+
94
+
http://www.apache.org/licenses/LICENSE-2.0
95
+
96
+
Unless required by applicable law or agreed to in writing, software
97
+
distributed under the License is distributed on an "AS IS" BASIS,
98
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
99
+
See the License for the specific language governing permissions and
100
+
limitations under the License.
101
+
```
102
102
4. Go to "Editor" → "Copyright" and choose the "Alibaba" profile as the default profile for this
103
103
project.
104
104
5. Click "Apply".
@@ -170,6 +170,48 @@ You can now import the Checkstyle configuration for the Java code formatter.
170
170
To verify the setup, click "View" → "Tool Windows" → "Checkstyle" and find the "Check Module"
171
171
button in the opened tool window. It should report no violations.
172
172
173
+
### Configure Git Commit Username and Email
174
+
175
+
Verify that the Git commit username is set to your preferred name using
176
+
177
+
```bash
178
+
git config user.name
179
+
```
180
+
181
+
The set username will be shown in the contributor list in Fluss release notes.
182
+
183
+
To change the username use
184
+
185
+
```bash
186
+
git config user.name "<Your username>"
187
+
```
188
+
189
+
You are free to choose any username you want.
190
+
In particular, the username does _not_ have to correspond to your GitHub username.
191
+
A common choice is simply your full name.
192
+
193
+
Also verify that the Git commit email address is set to your preferred email address using
194
+
195
+
```bash
196
+
git config user.email
197
+
```
198
+
199
+
Make sure that the set email address is an email address that is linked to your GitHub account.
200
+
If the email address is not linked to your GitHub account, commits in the contribution graph will not be associated with your account.
201
+
202
+
To change the email address use
203
+
204
+
```bash
205
+
git config user.email "<email address>"
206
+
```
207
+
208
+
If you do not want to expose your email address in Git commits, you can activate [GitHub's email privacy setting](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address) and set the Git commit email address to the anonymized `noreply @users.noreply.github.com` email address.
209
+
210
+
:::important
211
+
- When committing from different devices, make sure the username is consistently set on all devices.
212
+
- The `git config` commands above only set the username and email address for the current Git repository. If you want to apply the same settings to all Git repositories on a device, execute the commands with the `--global` option.
213
+
:::
214
+
173
215
### Common Problems
174
216
175
217
This section lists issues that developers have run into in the past when working with IntelliJ.
0 commit comments