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

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannesRabauer committed Feb 13, 2023
1 parent 2d5d4a9 commit 2969b95
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 14 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
## 1.0.0

* Published this library as open source
* Ensured build compatibility with Java 8, 11 and 17
39 changes: 26 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
## Contributing

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

### Get in touch with the team

Twitter: https://twitter.com/xdevsoftware
Twitter: https://twitter.com/xdevsoftware
<br/>
Mail: opensource@xdev-software.de

Expand All @@ -13,33 +15,44 @@ Mail: opensource@xdev-software.de
- **Report bugs**: File issues on GitHub.
- **Send pull requests**: If you want to contribute code, check out the development instructions below.

We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also.
We encourage you to read
the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing)
also.

## Developing

### Software Requirements

You should have the following things installed:

* Git
* Java 8, 11 or 17 - should be as unmodified as possible (Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
* Java 8, 11 or 17 - should be as unmodified as possible (
Recommended: [Eclipse Adoptium](https://adoptium.net/temurin/releases/))
* Maven

### Recommended setup

* Install ``IntelliJ`` (Community Edition is sufficient)
* Install the following plugins:
* [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running the formatter or adding ``final`` to fields
* [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
* [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
* Import the project
* Ensure that everything is encoded in ``UTF-8``
* Ensure that the JDK/Java-Version is correct
* Install the following plugins:
* [Save Actions](https://plugins.jetbrains.com/plugin/7642-save-actions) - Provides save actions, like running
the formatter or adding ``final`` to fields
* [SonarLint](https://plugins.jetbrains.com/plugin/7973-sonarlint) - CodeStyle/CodeAnalysis
* [Checkstyle-IDEA](https://plugins.jetbrains.com/plugin/1065-checkstyle-idea) - CodeStyle/CodeAnalysis
* Import the project
* Ensure that everything is encoded in ``UTF-8``
* Ensure that the JDK/Java-Version is correct

## 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)

Before releasing:
* Consider doing a [test-deployment](https://github.com/xdev-software/xapi-db-informix/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.

* Consider doing
a [test-deployment](https://github.com/xdev-software/xapi-db-informix/actions/workflows/test-deploy.yml?query=branch%3Adevelop)
before actually releasing.
* Check the [changelog](CHANGELOG.md)

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

When the release is finished do the following:
* Merge the auto-generated PR (with the incremented version number) back into the ``develop``

* Merge the auto-generated PR (with the incremented version number) back into the ``develop``
4 changes: 3 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

## Reporting a Vulnerability

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

0 comments on commit 2969b95

Please sign in to comment.