Skip to content

Commit 08abf4e

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent af4f0b5 commit 08abf4e

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

RELEASE_NOTES.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Frequenz Microgrid API Client Release Notes
22

3+
## Summary
4+
5+
<!-- Here goes a general summary of what this release is about -->
6+
37
## Upgrading
48

5-
- Now component and microgrid IDs are wrapped in new classes: `ComponentId` and `MicrogridId` respectively.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
10+
11+
## New Features
612

7-
These classes provide type safety and prevent accidental errors by:
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
814

9-
- Making it impossible to mix up microgrid and component IDs (equality comparisons between different ID types always return false).
10-
- Preventing accidental math operations on IDs.
11-
- Providing clear string representations for debugging (MID42, CID42).
12-
- Ensuring proper hash behavior in collections.
15+
## Bug Fixes
1316

14-
To migrate you just need to wrap your `int` IDs with the appropriate class: `0` -> `ComponentId(0)` / `MicrogridId(0)`.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)