onixbyte/onixbyte-bom
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: change to MIT license and reformat codes

Browse Source
This commit is contained in:
zihluwang
2025-06-17 23:07:52 +08:00
parent 7ea6646e89
commit a878422889
73 changed files with 1521 additions and 2522 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+16 -14
View File
@@ -1,18 +1,18 @@
# Contributing to Java Dev Kit
# Contributing to OnixByte Toolbox
We appreciate your interest in contributing to our Java Enterprise Utility Library. Contributions are welcome in various
forms such as code, documentation, bug reports, and test cases. To ensure a smooth collaboration, please follow the
guidelines outlined below.
We appreciate your interest in contributing to our Java Enterprise Utility Library. Contributions
are welcome in various forms such as code, documentation, bug reports, and test cases. To ensure a
smooth collaboration, please follow the guidelines outlined below.
## Getting Started
The Java Dev Kit is an open-source Java library designed to ease Java enterprise application development. It is built
with Java 17, and we require contributors to use OpenJDK 17.
The OnixByte Toolbox is an open-source Java library designed to ease Java enterprise
application development. It is built with Java 17, and we require contributors to use OpenJDK 17.
## Development Setup
There is no need for manual setup beyond ensuring you have JDK 17 and a stable internet connection. Our project uses
Gradle Wrapper for building, simplifying the setup process.
There is no need for manual setup beyond ensuring you have JDK 17 and a stable internet connection.
Our project uses Gradle Wrapper for building, simplifying the setup process.
```shell
./gradlew build
@@ -20,13 +20,13 @@ Gradle Wrapper for building, simplifying the setup process.
## Branching Strategy
We follow the `git-flow` branching model. Contributors should fork this repository and create their work on separate
branches prefixed with `feature/` or `hotfix/` as appropriate.
We follow the `git-flow` branching model. Contributors should fork this repository and create their
work on separate branches prefixed with `feature/` or `hotfix/` as appropriate.
## Code Style
Please adhere to the coding standards specified in our `.editorconfig` file in the root of the repository. Consistent
style helps in maintaining readability and uniformity across the codebase.
Please adhere to the coding standards specified in our `.editorconfig` file in the root of
the repository. Consistent style helps in maintaining readability and uniformity across the codebase.
## Commit Messages
@@ -52,8 +52,10 @@ This format helps in auto-generating changelogs and understanding the purpose be
## Testing
We encourage using JUnit Jupiter for unit and integration tests. Pull Requests with accompanying test reports are prioritised for review and merging.
We encourage using JUnit Jupiter for unit and integration tests. Pull Requests with accompanying
test reports are prioritised for review and merging.
## License
By contributing to the Java Dev Kit, you agree that your contributions will be licensed under the Apache 2.0 license. If you do not agree to this, please refrain from contributing.
By contributing to the Java Dev Kit, you agree that your contributions will be licensed under the
MIT license. If you do not agree to this, please refrain from contributing.