Skip to content

Commit 19d1ed0

Browse files
committed
Update RELEASE_NOTES
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 23cff22 commit 19d1ed0

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

RELEASE_NOTES.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,39 @@
22

33
## Summary
44

5-
<!-- Here goes a general summary of what this release is about -->
5+
This release is a major step and adds many features and breaking changes.
66

77
## Upgrading
88

9-
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
9+
Since this projects is still in very heavy devepoment, the easiest way to
10+
upgrade is to just regenerate the templates. Please follow the instructions in
11+
the new documentation website about [updating
12+
projects](https://frequenz-floss.github.io/frequenz-repo-config-python/next/#update-an-existing-project).
1013

1114
## New Features
1215

13-
<!-- Here goes the main new features and examples or instructions on how to use them -->
16+
This is just a quick (non-comprehensive) summary of the new features:
17+
18+
* Add `--diff` as a default argument for `isort`
19+
* Improve `README`
20+
* Don't import modules into packages
21+
* Support migrating and updating existing projects with Cookiecutter
22+
* Cookiecutter template
23+
24+
* Add `dependabot` configuration
25+
* Add issue templates, keyword labeler and PR labeler
26+
* Add `CODEOWNERS` file
27+
* Add `direnv`-related files to `.gitignore`
28+
* Add GitHub CI workflow to `cookiecutter`
29+
* Add `CONTRIBUTING` guide to `cookiecutter`
30+
* Add `RELEASE_NOTES` to `cookiecutter`
31+
* Add support to generate documentation using `mkdocs`
32+
33+
* Apply all the Cookiecutter template improvements to this project
1434

1535
## Bug Fixes
1636

17-
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
37+
This is just a quick (non-comprehensive) summary of bug fixes:
38+
39+
* Fix some comments about creating labels
40+
* Fix tests

0 commit comments

Comments
 (0)