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: CONTRIBUTING.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,34 @@
1
1
## Contributing
2
2
3
+
We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request and anything that you build and share using our components.
4
+
5
+
### Communication channels
6
+
* Communication is primarily done using issues.
7
+
* If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
8
+
* As a last resort measure or on otherwise important matter you may also [contact us directly](https://xdev.software/en/about-us/contact).
9
+
10
+
### Ways to help
11
+
***Report bugs**<br/>Create an issue or send a pull request
12
+
***Send pull requests**<br/>If you want to contribute code, check out the development instructions below.
13
+
* However when contributing new features, please first discuss the change you wish to make via issue with the owners of this repository before making a change. Otherwise your work might be rejected and your effort was pointless.
14
+
15
+
We also encourage you to read the [contribution instructions by GitHub](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
16
+
3
17
## Developing
4
18
5
19
### Software Requirements
6
20
You should have the following things installed:
7
21
* Git
8
22
* Java 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
9
-
* Gradle (shipped inside the repo as Gradle Wrapper - also available inside Intellij)
23
+
* Gradle (shipped inside the repo as Gradle Wrapper - also available inside IntelliJ)
10
24
11
25
### Recommended setup
12
26
* Install ``IntelliJ`` (Community Edition is sufficient)
13
27
* Install the following plugins:
14
28
*[Save Actions](https://plugins.jetbrains.com/plugin/22113) - Provides save actions, like running the formatter or adding ``final`` to fields
*[Plugin DevKit](https://plugins.jetbrains.com/plugin/22851) - Intellij Plugin development
31
+
*[Plugin DevKit](https://plugins.jetbrains.com/plugin/22851) - IntelliJ Plugin development
18
32
* Import the project
19
33
* Ensure that everything is encoded in ``UTF-8``
20
34
* Ensure that the JDK/Java-Version is correct
@@ -23,7 +37,7 @@ You should have the following things installed:
23
37
24
38
<i>See also [JetBrains Docs for developing IntelliJ Plugins](https://plugins.jetbrains.com/docs/intellij/developing-plugins.html)</i>
25
39
26
-
The plugin is built with gradle, but you don't need to install it if you build with the Intellij gradle plugin (check out the [prerequisites](https://www.jetbrains.org/intellij/sdk/docs/tutorials/build_system/prerequisites.html)). If you don't intend to use the Intellij gradle plugin, you can use native gradle (replace `./gradlew` by `gradle`).
40
+
The plugin is built with gradle, but you don't need to install it if you build with the Intellij gradle plugin (check out the [prerequisites](https://plugins.jetbrains.com/docs/intellij/plugin-required-experience.html)). If you don't intend to use the IntelliJ gradle plugin, you can use native gradle (replace `./gradlew` by `gradle`).
27
41
28
42
Start idea and import the `build.gradle` file with "File > Open". Then in the "Import Project from Gradle" window, make sure you check "Use gradle 'wrapper' task configuration" before clicking "Finish". You now have a gradle wrapper installed (`gradlew`) that you can use on the command line to generate idea folders:
29
43
@@ -32,7 +46,7 @@ Start idea and import the `build.gradle` file with "File > Open". Then in the "I
32
46
./gradlew cleanIdea idea
33
47
```
34
48
35
-
Intellij should refresh and the project is now configured as a gradle project. You can find Intellij gradle tasks in "Gradle > Gradle projects > intellij-plugin-save-actions > Tasks > intellij". To run the plugin, use the `runIde` task:
49
+
IntelliJ should refresh and the project is now configured as a gradle project. You can find IntelliJ gradle tasks in "Gradle > Gradle projects > intellij-plugin-save-actions > Tasks > intellij". To run the plugin, use the `runIde` task:
0 commit comments