Skip to content

Commit 16e1997

Browse files
committed
Update CONTRIBUTING.md
1 parent a5eb0f5 commit 16e1997

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
11
## Contributing
22

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+
317
## Developing
418

519
### Software Requirements
620
You should have the following things installed:
721
* Git
822
* 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)
1024

1125
### Recommended setup
1226
* Install ``IntelliJ`` (Community Edition is sufficient)
1327
* Install the following plugins:
1428
* [Save Actions](https://plugins.jetbrains.com/plugin/22113) - Provides save actions, like running the formatter or adding ``final`` to fields
1529
* [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
1630
* [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
17-
* [Plugin DevKit](https://plugins.jetbrains.com/plugin/22851) - Intellij Plugin development
31+
* [Plugin DevKit](https://plugins.jetbrains.com/plugin/22851) - IntelliJ Plugin development
1832
* Import the project
1933
* Ensure that everything is encoded in ``UTF-8``
2034
* Ensure that the JDK/Java-Version is correct
@@ -23,7 +37,7 @@ You should have the following things installed:
2337

2438
<i>See also [JetBrains Docs for developing IntelliJ Plugins](https://plugins.jetbrains.com/docs/intellij/developing-plugins.html)</i>
2539

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`).
2741

2842
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:
2943

@@ -32,7 +46,7 @@ Start idea and import the `build.gradle` file with "File > Open". Then in the "I
3246
./gradlew cleanIdea idea
3347
```
3448

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:
3650

3751
```bash
3852
# Run the plugin (starts new idea)

0 commit comments

Comments
 (0)