|
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 in the repositories, and anything that you build and share using our components. |
| 3 | +We would absolutely love to get the community involved, and we welcome any form of contributions – comments and |
| 4 | +questions on different communication channels, issues and pull request in the repositories, and anything that you build |
| 5 | +and share using our components. |
4 | 6 |
|
5 | 7 | ### Get in touch with the team
|
6 | 8 |
|
7 |
| -Twitter: https://twitter.com/xdevsoftware |
| 9 | +Twitter: https://twitter.com/xdevsoftware |
8 | 10 | <br/>
|
9 | 11 |
|
10 | 12 |
|
|
13 | 15 | - **Report bugs**: File issues on GitHub.
|
14 | 16 | - **Send pull requests**: If you want to contribute code, check out the development instructions below.
|
15 | 17 |
|
16 |
| -We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also. |
| 18 | +We encourage you to read |
| 19 | +the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) |
| 20 | +also. |
17 | 21 |
|
18 | 22 | ## Developing
|
19 | 23 |
|
20 | 24 | ### Software Requirements
|
| 25 | + |
21 | 26 | You should have the following things installed:
|
| 27 | + |
22 | 28 | * Git
|
23 |
| -* Java 8, 11 or 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/)) |
| 29 | +* Java 8, 11 or 17 - should be as unmodified as possible ( |
| 30 | + Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/)) |
24 | 31 | * Maven
|
25 | 32 |
|
26 | 33 | ### Recommended setup
|
| 34 | + |
27 | 35 | * Install ``IntelliJ`` (Community Edition is sufficient)
|
28 |
| - * Install the following plugins: |
29 |
| - * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields |
30 |
| - * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis |
31 |
| - * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis |
32 |
| - * Import the project |
33 |
| - * Ensure that everything is encoded in ``UTF-8`` |
34 |
| - * Ensure that the JDK/Java-Version is correct |
| 36 | + * Install the following plugins: |
| 37 | + * [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running |
| 38 | + the formatter or adding ``final`` to fields |
| 39 | + * [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis |
| 40 | + * [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis |
| 41 | + * Import the project |
| 42 | + * Ensure that everything is encoded in ``UTF-8`` |
| 43 | + * Ensure that the JDK/Java-Version is correct |
35 | 44 |
|
36 | 45 | ## Releasing [](https://github.com/xdev-software/xapi-db-informix/actions/workflows/release.yml)
|
37 | 46 |
|
38 | 47 | Before releasing:
|
39 |
| -* Consider doing a [test-deployment](https://github.com/xdev-software/xapi-db-informix/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing. |
| 48 | + |
| 49 | +* Consider doing |
| 50 | + a [test-deployment](https://github.com/xdev-software/xapi-db-informix/actions/workflows/test-deploy.yml?query=branch%3Adevelop) |
| 51 | + before actually releasing. |
40 | 52 | * Check the [changelog](CHANGELOG.md)
|
41 | 53 |
|
42 | 54 | If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes.
|
43 | 55 |
|
44 | 56 | When the release is finished do the following:
|
45 |
| -* Merge the auto-generated PR (with the incremented version number) back into the ``develop`` |
| 57 | + |
| 58 | +* Merge the auto-generated PR (with the incremented version number) back into the ``develop`` |
0 commit comments