This is an automated email from the ASF dual-hosted git repository.
unknown pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/helix.wiki.git
The following commit(s) were added to refs/heads/master by this push:
new f6f5968 Add howto guide to setup code style in Intellij.
f6f5968 is described below
commit f6f5968713f8a31e6c2ed366f1f494ff8e270882
Author: pkuwm <[email protected]>
AuthorDate: Fri Sep 20 11:39:29 2019 -0700
Add howto guide to setup code style in Intellij.
---
Helix-Code-Style-in-Intellij-IDE.md | 45 +++++++++++++++++++++++++++++++++++++
1 file changed, 45 insertions(+)
diff --git a/Helix-Code-Style-in-Intellij-IDE.md
b/Helix-Code-Style-in-Intellij-IDE.md
new file mode 100644
index 0000000..d399460
--- /dev/null
+++ b/Helix-Code-Style-in-Intellij-IDE.md
@@ -0,0 +1,45 @@
+## Background
+The intention of this guide is to provide steps to setup code style in
IntelliJ IDE for Helix.
+
+## Configure Code Style in IntelliJ for Helix Development
+### Configure a new copyright profile
+1. In the Settings/Preferences dialog (⌃⌥S) (For Mac users, use command-comma
⌘,), select **Editor | Copyright | Copyright Profiles**.
+2. Click **+** and name the new profile.
+3. Enter below Apache License as copyright notice text.
+```
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+```
+click **Validate** to make sure that it is configured correctly.
+
+
+
+### Configure copyright text format
+1. In the Settings/Preferences dialog (⌃⌥S) (For Mac users, use command-comma
⌘,), select **Editor | Copyright | Formatting | Java**.
+2. In **Location in File**, check **Before Imports**
+
+
+
+### Import code style schema
+1. **File | Settings | Editor | Code Style**
+2. Select the small gear icon next to **Scheme**, select **Import Scheme |
IntelliJ IDEA code style XML**
+3. Select the file **helix-style-intellij.xml**
+4. Select **OK | Apply | OK**
+Ensure the **Helix Style** Scheme is selected.
+
+
+
