Skip to content

Commit 2e1d207

Browse files
committed
Release v1.0.1
0 parents  commit 2e1d207

27 files changed

Lines changed: 3307 additions & 0 deletions

.github/workflows/test.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Test
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
java-version: ["11", "17", "21"]
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Java ${{ matrix.java-version }}
20+
uses: actions/setup-java@v4
21+
with:
22+
java-version: ${{ matrix.java-version }}
23+
distribution: "temurin"
24+
cache: "maven"
25+
26+
- name: Run tests
27+
run: mvn test -B
28+
29+
- name: Build package
30+
run: mvn package -B -DskipTests
31+

.gitignore

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Maven
2+
target/
3+
pom.xml.tag
4+
pom.xml.releaseBackup
5+
pom.xml.versionsBackup
6+
pom.xml.next
7+
release.properties
8+
dependency-reduced-pom.xml
9+
buildNumber.properties
10+
.mvn/timing.properties
11+
.mvn/wrapper/maven-wrapper.jar
12+
13+
# IDE
14+
.idea/
15+
*.iml
16+
*.ipr
17+
*.iws
18+
.project
19+
.classpath
20+
.settings/
21+
.vscode/
22+
*.swp
23+
*.swo
24+
25+
# Build
26+
build/
27+
dist/
28+
*.jar
29+
*.war
30+
*.ear
31+
32+
# OS
33+
.DS_Store
34+
Thumbs.db
35+
36+
# Logs
37+
*.log
38+

CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [1.0.1] - 2025-12-10
9+
10+
- Java SDK with Maven support and JUnit 5 testing framework
11+

CONTRIBUTING.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing to Klime Java SDK
2+
3+
Thank you for your interest in contributing to the Klime Java SDK!
4+
5+
## Important: Repository Structure
6+
7+
This repository is a **read-only mirror** of our internal monorepo.
8+
9+
### What This Means for Contributors
10+
11+
- **Pull requests are welcome** and will be reviewed
12+
- If accepted, we'll **manually port changes** to our internal monorepo
13+
- Changes appear in this repository with the **next release**
14+
- You'll be credited as a co-author in the commit
15+
16+
## How to Contribute
17+
18+
1. **Fork this repository**
19+
20+
2. **Clone your fork**
21+
```bash
22+
git clone https://github.com/YOUR_USERNAME/klime-java.git
23+
cd klime-java
24+
```
25+
26+
3. **Create a feature branch**
27+
```bash
28+
git checkout -b feature/your-feature-name
29+
```
30+
31+
4. **Make your changes**
32+
- Follow Java coding conventions
33+
- Add tests for new functionality
34+
- Update documentation as needed
35+
36+
5. **Run the tests**
37+
```bash
38+
mvn test
39+
```
40+
41+
6. **Commit your changes**
42+
```bash
43+
git commit -m "Add: description of your change"
44+
```
45+
46+
7. **Push to your fork**
47+
```bash
48+
git push origin feature/your-feature-name
49+
```
50+
51+
8. **Open a Pull Request**
52+
53+
## Development Setup
54+
55+
### Prerequisites
56+
57+
- Java 11 or later
58+
- Maven 3.6+
59+
60+
### Building
61+
62+
```bash
63+
# Compile
64+
mvn compile
65+
66+
# Run tests
67+
mvn test
68+
69+
# Package
70+
mvn package
71+
72+
# Install to local Maven repository
73+
mvn install
74+
```
75+
76+
### Code Style
77+
78+
- Follow standard Java conventions
79+
- Use meaningful variable and method names
80+
- Add Javadoc for public methods
81+
- Keep methods focused and small
82+
- Prefer immutability where possible
83+
84+
### Testing
85+
86+
- Write unit tests for all new functionality
87+
- Integration tests should use the built-in HTTP server (`com.sun.net.httpserver`)
88+
- Disable auto-flush in tests to avoid flakiness
89+
- Tests should be fast (< 100ms total)
90+
91+
## Reporting Issues
92+
93+
- Check existing issues before creating a new one
94+
- Include Java version and Maven version
95+
- Provide a minimal reproducible example
96+
- Include stack traces for errors
97+
98+
## Questions?
99+
100+
If you have questions about contributing, feel free to open an issue with the "question" label.
101+

LICENSE.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Klime
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
22+

0 commit comments

Comments
 (0)