|
2 | 2 |
|
3 | 3 | ## Summary |
4 | 4 |
|
5 | | -This version focus on some bug fixes and final polishing of v0.5.x. |
| 5 | +<!-- Here goes a general summary of what this release is about --> |
6 | 6 |
|
7 | 7 | ## Upgrading |
8 | 8 |
|
9 | | -### Cookiecutter template |
10 | | - |
11 | | -- If your replay file contains a `_extensions` key, you should remove it, as you most likely want to use the extensions declared by the repo-config cookiecutter template you are upgrading to, otherwise you could get errors about missing extensions. |
12 | | - |
13 | | -- If your replay file contains a long `Introduction` key, you can replace it with an empty string (`""`), it doesn't need to have any particular content and it increases the size and noise in the replay file. |
14 | | - |
15 | | -## New Features |
| 9 | +<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> |
16 | 10 |
|
17 | 11 | ### Cookiecutter template |
18 | 12 |
|
19 | | -- Generated project's dependencies were bumped. |
20 | | - |
21 | | -- Move `TODO`s so they are in their own line. |
22 | | - |
23 | | - This makes it easier to upgrade projects to new templates, as removing whole lines is easier than having to edit them. |
| 13 | +<!-- Here upgrade steps for cookiecutter specifically --> |
24 | 14 |
|
25 | | -- Clean up `_extensions` from the generated replay file. |
26 | | - |
27 | | - It is not needed in the generated project, we always want to use the ones from the repo-config template. |
28 | | - |
29 | | - This should ease upgrading projects, making it less likely to have errors about missing extensions. |
30 | | - |
31 | | -- Clean up the `Introduction` variable from the generated replay file. |
32 | | - |
33 | | - This is just a hack to be able to show a help about the template variables, keeping that text only increases the size and noise in the replay file. |
| 15 | +## New Features |
34 | 16 |
|
35 | | -- Add a `\n` to the end of the replay file. |
| 17 | +<!-- Here goes the main new features and examples or instructions on how to use them --> |
36 | 18 |
|
37 | | - This is just to be nice to most editors and text files conventions, that likes it more if there is a `\n` at the end of the file. |
| 19 | +### Cookiecutter template |
38 | 20 |
|
39 | | -- API: The common-api documentation now is cross-linked. |
| 21 | +<!-- Here new features for cookiecutter specifically --> |
40 | 22 |
|
41 | 23 | ## Bug Fixes |
42 | 24 |
|
| 25 | +<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |
| 26 | + |
43 | 27 | ### Cookiecutter template |
44 | 28 |
|
45 | | -- Properly label `conftest.py` files. |
| 29 | +<!-- Here bug fixes for cookiecutter specifically --> |
0 commit comments