diff --git a/CHANGELOG.md b/CHANGELOG.md index e69de29..8e665e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ +## 1.0.0 + +* Published this library as open source +* Ensured build compatibility with Java 8, 11 and 17 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d66a04..54bf516 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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
Mail: opensource@xdev-software.de @@ -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`` \ No newline at end of file + +* Merge the auto-generated PR (with the incremented version number) back into the ``develop`` diff --git a/SECURITY.md b/SECURITY.md index 251cf73..ebdd153 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -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) +.