diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f70861d..a244d96 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -93,25 +93,12 @@ from [API Guardian](https://github.com/apiguardian-team/apiguardian). We use [Checkstyle](https://checkstyle.sourceforge.io/) in our build workflow to validate coding style. -It is recommended to import the [config/checkstyle/checkstyle.xml](../config/checkstyle/checkstyle.xml) file into your +It is recommended to import the [config/checkstyle/checkstyle.xml](../config/checkstyle/checkstyle.xml) or [config/intellij-code-style.xml](config/intellij-code-style.xml) file into your IDE, so that formatting rules are respected. Moreover, the [CheckStyle-IDEA plugin](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) can be used to check if there are no style violations. -### Import order - -IntellIJ does not import the `import` order rules correctly. Apply following order manually: - -- import `com.refinedmods.*` -- blank line -- import `java.*` -- import `javax.*` -- blank line -- import all other imports -- blank line -- import static all other imports - ## Architecture ## Testing diff --git a/config/intellij-code-style.xml b/config/intellij-code-style.xml new file mode 100644 index 0000000..9a82b0f --- /dev/null +++ b/config/intellij-code-style.xml @@ -0,0 +1,64 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file