Skip to content

Commit 3df909f

Browse files
committed
docs: add CHANGELOG (Keep a Changelog format)
Reconstruct release notes for 0.0.5 through 0.3.0 from git history, including the 0.3.0 breaking rename of OpenGJKSharp to OpenGjk
1 parent 207fa9d commit 3df909f

1 file changed

Lines changed: 66 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
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+
## [Unreleased]
9+
10+
### Added
11+
12+
- `netstandard2.1` target: the package can now be used from .NET Core 3.0+, Unity 2021.2+, and Mono in addition to .NET 8
13+
- SourceLink and symbol package (`.snupkg`) for source-level debugging
14+
15+
### Changed
16+
17+
- NuGet publishing now happens only on `v*` release tag push (previously on every push to `main`), with a tag-vs-csproj version check
18+
19+
## [0.3.0] - 2026-07-10
20+
21+
### Changed
22+
23+
- **Breaking:** rename the entry-point class `OpenGJKSharp` to `OpenGjk`. The old name collided with the namespace, so consumers could not reference it without a namespace alias
24+
- Replace `Console.WriteLine` noise in the library with `Debug.WriteLine`
25+
- Ship IntelliSense XML documentation with the package
26+
27+
### Added
28+
29+
- Input validation with clear exceptions: null/empty vertex arrays, non-finite (NaN/Infinity) coordinates, negative precision, and `GkPolytope` shape mismatches
30+
- `ComputeMinimumDistance` overloads for `Vector3[]`/`Vector2[]` that return the distance and the closest point on each body (witness points)
31+
32+
### Fixed
33+
34+
- EPA reporting zero penetration depth when both bodies share their first vertex
35+
- EPA mis-orienting face normals when a polytope face passes through the origin, which stalled EPA at ~0 penetration depth for sphere-like hulls
36+
- Missing returns in degenerate witness branches that could produce NaN results
37+
38+
## [0.2.0] - 2026-07-09
39+
40+
### Changed
41+
42+
- Apply modern C# conventions to the model types (public fields to properties)
43+
- Fix the `_presicion` typo to `_precision`
44+
45+
## [0.1.0] - 2026-07-09
46+
47+
### Added
48+
49+
- EPA (Expanding Polytope Algorithm) ported from upstream openGJK: `ComputeCollisionInformation` returns the penetration depth and contact normal
50+
- `Vector3` convenience overload and a `ComputeMinimumDistance` overload accepting a `GkSimplex`
51+
52+
### Changed
53+
54+
- NuGet publishing switched from an API key to Trusted Publishing (OIDC)
55+
56+
## [0.0.5] - 2025-03-08
57+
58+
### Added
59+
60+
- Initial release: GJK minimum distance and `HasCollision` for convex polyhedra (`Vector3[]`) and flat polygons (`Vector2[]`)
61+
62+
[Unreleased]: https://github.com/HanJaeJoon/OpenGJKSharp/compare/v0.3.0...HEAD
63+
[0.3.0]: https://github.com/HanJaeJoon/OpenGJKSharp/compare/v0.2.0...v0.3.0
64+
[0.2.0]: https://github.com/HanJaeJoon/OpenGJKSharp/compare/v0.1.0...v0.2.0
65+
[0.1.0]: https://github.com/HanJaeJoon/OpenGJKSharp/compare/v0.0.5...v0.1.0
66+
[0.0.5]: https://github.com/HanJaeJoon/OpenGJKSharp/releases/tag/v0.0.5

0 commit comments

Comments
 (0)