Skip to content

Commit 9ba78ec

Browse files
committed
Add release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent ef4f5d0 commit 9ba78ec

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

RELEASE_NOTES.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,34 @@
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+
- `flake8` basic checks are enabled now. Most are already covered by `pylint`, but there are a few differences, so you might need to fix your code if `flake8` find some issues.
10+
11+
- `darglint` was replaced by `pydoclint`, `pydoclint` can find a few more issues than `darglint`, so your code might need adjusting.
12+
13+
- `darglint` is not used anymore, but if it is installed, it will make `flake8` run extremely slowly anyways, so it is extremely recommended to uninstall it (`pip uninstall darglint`) and rebuild you `nox` *venvs* if you use `-R`.
14+
15+
- If you are upgrading without regenerating the cookiecutter templates, you'll need to adjust the dependencies accordingly.
1016

1117
### Cookiecutter template
1218

13-
<!-- Here upgrade steps for cookiecutter specifically -->
19+
- See the general upgrading section.
1420

1521
## New Features
1622

17-
<!-- Here goes the main new features and examples or instructions on how to use them -->
23+
- `flake8` is now used to check the files.
1824

19-
### Cookiecutter template
25+
- `darlint` was replaced by `pydoclint`, which is way faster and detect more issues.
2026

27+
### Cookiecutter template
2128

2229
- Now dependabot updates will be done weekly and grouped by *required* and *optional* for minor and patch updates (major updates are still done individually for each dependency).
2330

2431
- ci: Add debug information when installing pip packages.
2532

2633
The output of `pip freeze` is printed to be able to more easily debug different behaviours between GitHub workflow runs and local runs.
2734

35+
- See the general new features section.
36+
2837
## Bug Fixes
2938

3039
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)