Skip to content
This repository was archived by the owner on Jan 18, 2024. It is now read-only.

Commit 290ad97

Browse files
Merge pull request #3 from xdev-software/develop
Cleanup
2 parents 35eee09 + 4e471ae commit 290ad97

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
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 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.
46

57
### Get in touch with the team
68

7-
Twitter: https://twitter.com/xdevsoftware
9+
Twitter: https://twitter.com/xdevsoftware
810
<br/>
911
Mail: opensource@xdev-software.de
1012

@@ -13,20 +15,27 @@ Mail: opensource@xdev-software.de
1315
- **Report bugs**: File issues on GitHub.
1416
- **Send pull requests**: If you want to contribute code, check out the development instructions below.
1517

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.
1721

1822
## Developing
1923

2024
### Software Requirements
25+
2126
You should have the following things installed:
27+
2228
* 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/))
2431
* Maven
2532

2633
### Recommended setup
34+
2735
* Install ``IntelliJ`` (Community Edition is sufficient)
2836
* 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
37+
* [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the
38+
formatter or adding ``final`` to fields
3039
* [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
3140
* [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
3241
* Import the project
@@ -36,10 +45,14 @@ You should have the following things installed:
3645
## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/xapi-db-sqlite/release.yml?branch=master)](https://github.com/xdev-software/xapi-db-sqlite/actions/workflows/release.yml)
3746

3847
Before releasing:
39-
* Consider doing a [test-deployment](https://github.com/xdev-software/xapi-db-sqlite/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-sqlite/actions/workflows/test-deploy.yml?query=branch%3Adevelop)
51+
before actually releasing.
4052
* Check the [changelog](CHANGELOG.md)
4153

4254
If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes.
4355

4456
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``

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,4 @@ General Public License ever published by the Free Software Foundation.
162162
whether future versions of the GNU Lesser General Public License shall
163163
apply, that proxy's public statement of acceptance of any version is
164164
permanent authorization for you to choose that version for the
165-
Library.
165+
Library.

0 commit comments

Comments
 (0)