Skip to content
This repository was archived by the owner on Jun 27, 2023. It is now read-only.

Commit 2969b95

Browse files
Cleanup
1 parent 2d5d4a9 commit 2969b95

File tree

3 files changed

+33
-14
lines changed

3 files changed

+33
-14
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## 1.0.0
2+
3+
* Published this library as open source
4+
* Ensured build compatibility with Java 8, 11 and 17

CONTRIBUTING.md

+26-13
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
1012

@@ -13,33 +15,44 @@ Mail: [email protected]
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)
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
3544

3645
## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/xapi-db-informix/release.yml?branch=master)](https://github.com/xdev-software/xapi-db-informix/actions/workflows/release.yml)
3746

3847
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.
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``

SECURITY.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22

33
## Reporting a Vulnerability
44

5-
Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/xapi-db-informix/security/advisories/new).
5+
Please report a security
6+
vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/xapi-db-informix/security/advisories/new)
7+
.

0 commit comments

Comments
 (0)