Skip to content

Commit 0153580

Browse files
committed
Clean RELEASE_NOTES
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 96af074 commit 0153580

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

RELEASE_NOTES.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# `frequenz-channels` Release Notes
1+
# Frequenz Channels Release Notes
22

33
## Summary
44

5-
This is the first public open source release based on the internal SDK version v0.9.0. There are no breaking changes in this release, only changes to the project structure, metadata, and automation. Packages are also now uploaded to PyPI as [`frequenz-channels`](https://pypi.org/project/frequenz-channels/), so this project now can be installed normally via `pip`:
5+
<!-- Here goes a general summary of what this release is about -->
66

7-
```sh
8-
python -m pip install frequenz-channels
9-
```
7+
## Upgrading
108

11-
The GitHub issues were also improved, adding templates for [reporting issues](https://github.com/frequenz-floss/frequenz-channels/issues/new?assignees=&labels=priority%3A%E2%9D%93%2C+type%3Abug&template=bug.yml) and [requesting features](https://github.com/frequenz-floss/frequenz-channels/issues/new?assignees=&labels=part%3A%E2%9D%93%2C+priority%3A%E2%9D%93%2C+type%3Aenhancement&template=feature.yml). Users are also pointed to the [Discussion forums](https://github.com/frequenz-floss/frequenz-channels/issues/new/choose) when trying to open an issue if they have questions instead. Also many labels are assigned automatically on issue and pull request creation.
9+
<!-- Here goes notes on how to upgrade from previous versions, including if there are any depractions and what they should be replaced with -->
10+
11+
## New Features
12+
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
14+
15+
## Bug Fixes
16+
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)