Skip to content

Commit 0505810

Browse files
authored
docs: remove references to removed hugegraph-style.xml (#2949)
1 parent ef2db2c commit 0505810

5 files changed

Lines changed: 12 additions & 14 deletions

File tree

.serena/memories/code_style_and_conventions.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
# Code Style and Conventions
22

33
## Code Style Configuration
4-
- **Import**: Use `hugegraph-style.xml` in your IDE (IntelliJ IDEA recommended)
5-
- **EditorConfig**: `.editorconfig` file defines style rules (validated in CI)
6-
- **Checkstyle**: `style/checkstyle.xml` defines additional rules
4+
- **EditorConfig**: `.editorconfig` file defines style rules
5+
- **Checkstyle**: `style/checkstyle.xml` defines additional rules and enforcement
76

87
## Core Style Rules (from .editorconfig)
98

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ mvn clean package -DskipTests -Dskip-assembly-hugegraph
182182
## Development Workflow
183183

184184
### Code Style
185-
Import the code style configuration from `hugegraph-style.xml` in your IDE (IntelliJ IDEA recommended).
185+
Configure your IDE to use `.editorconfig` for code style and `style/checkstyle.xml` for Checkstyle rules
186186

187187
### Adding Dependencies
188188

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ vim hugegraph-server/hugegraph-core/src/main/java/org/apache/hugegraph/HugeFacto
7171
# run test locally (optional)
7272
mvn test -Pcore-test,memory
7373
```
74-
Note: To be consistent with the code style easily, if you use [IDEA](https://www.jetbrains.com/idea/) as your IDE, you can directly [import](https://www.jetbrains.com/help/idea/configuring-code-style.html) our code style [configuration file](./hugegraph-style.xml).
74+
Note: Code style is defined by the `.editorconfig` file at the repository root. Checkstyle rules are defined in `style/checkstyle.xml`. Configure your IDE accordingly.
7575

7676
##### 3.2.1 Check licenses
7777
If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things:

hugegraph-pd/docs/development.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,8 @@ cd hugegraph-pd
6363
#### Configure Code Style
6464

6565
1. **File → Settings → Editor → Code Style**
66-
2. **Import Scheme → IntelliJ IDEA code style XML**
67-
3. Select `hugegraph-style.xml` from repository root
68-
4. **Apply** and **OK**
66+
2. Ensure **Enable EditorConfig support** is checked
67+
3. **Apply** and **OK**
6968

7069
#### Enable Annotation Processing
7170

@@ -277,9 +276,9 @@ ls -lh pd_data/raft/snapshot/
277276

278277
HugeGraph PD follows Apache HugeGraph code style.
279278

280-
**Import Code Style**:
279+
**IDE Configuration**:
281280
1. IntelliJ IDEA: **File → Settings → Editor → Code Style**
282-
2. **Import Scheme** → Select `hugegraph-style.xml` (in repository root)
281+
2. Ensure **Enable EditorConfig support** is checked
283282

284283
**Key Style Rules**:
285284
- **Indentation**: 4 spaces (no tabs)

hugegraph-store/docs/development-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ git checkout 1.7-rebase
4848

4949
**Code Style**:
5050
```bash
51-
# Import code style
52-
# File → Settings → Editor → Code Style → Java
53-
# Import Scheme → hugegraph-style.xml
51+
# Configure IDE code style
52+
# Ensure EditorConfig support is enabled
53+
# Code style is defined in .editorconfig at repository root
5454
```
5555

5656
**Run Configuration**:
@@ -683,7 +683,7 @@ jmap -dump:format=b,file=heap.bin $(pgrep -f hugegraph-store)
683683
### Code Style
684684

685685
**Java**:
686-
- Follow Apache HugeGraph code style (import `hugegraph-style.xml`)
686+
- Follow Apache HugeGraph code style (configured via `.editorconfig`)
687687
- Use 4 spaces for indentation (no tabs)
688688
- Max line length: 120 characters
689689
- Braces on same line (K&R style)

0 commit comments

Comments
 (0)