|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
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. |
6 | 6 |
|
7 | 7 | ## Upgrading |
8 | 8 |
|
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). |
10 | 13 |
|
11 | 14 | ## New Features |
12 | 15 |
|
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 |
14 | 34 |
|
15 | 35 | ## Bug Fixes |
16 | 36 |
|
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