| Manuel Pégourié-Gonnard | f5acfba | 2021-04-26 09:57:40 +0200 | [diff] [blame] | 1 | Please add your migration guide entries here. Until 3.0 is released, each PR |
| 2 | that makes backwards-incompatible changes should add a file here, with the |
| 3 | extension .md, a descriptive name and the following format: |
| Manuel Pégourié-Gonnard | b2a1043 | 2021-04-23 11:59:00 +0200 | [diff] [blame] | 4 | |
| Manuel Pégourié-Gonnard | f5acfba | 2021-04-26 09:57:40 +0200 | [diff] [blame] | 5 | ---%<------%<------%<------%<------%<------%<------%<------%<--- |
| Manuel Pégourié-Gonnard | b2a1043 | 2021-04-23 11:59:00 +0200 | [diff] [blame] | 6 | |
| Manuel Pégourié-Gonnard | 438ac27 | 2021-05-04 13:06:34 +0200 | [diff] [blame] | 7 | The change that was made |
| Manuel Pégourié-Gonnard | f5acfba | 2021-04-26 09:57:40 +0200 | [diff] [blame] | 8 | ------------------------ |
| 9 | |
| 10 | Who exactly is affected: does this affect users of the default config, of a |
| 11 | particular feature? Remember to contextualise. |
| 12 | |
| 13 | If I'm affected, what's my migration path? How should I change my code if this |
| Manuel Pégourié-Gonnard | 72f762b | 2021-05-04 11:24:49 +0200 | [diff] [blame] | 14 | is an API change; if a feature was removed what are my alternatives? |
| Manuel Pégourié-Gonnard | f5acfba | 2021-04-26 09:57:40 +0200 | [diff] [blame] | 15 | |
| 16 | ---%<------%<------%<------%<------%<------%<------%<------%<--- |
| 17 | |
| Manuel Pégourié-Gonnard | 72f762b | 2021-05-04 11:24:49 +0200 | [diff] [blame] | 18 | PRs that make multiple independent changes should include one entry for each |
| 19 | changes or logical groups of changes. You can either add multiple files or put |
| 20 | multiple entries in the same file. |
| 21 | |
| Manuel Pégourié-Gonnard | f5acfba | 2021-04-26 09:57:40 +0200 | [diff] [blame] | 22 | For examples, have a look a docs/3.0-migration-guide.md (which includes the |
| 23 | top-level header and an intro before the list of entries). |
| 24 | |
| 25 | As part of release preparation, the entries in this directory will be appended |
| 26 | to docs/3.0-migration-guide.md and then re-ordered and reviewed one last time. |
| Manuel Pégourié-Gonnard | 72f762b | 2021-05-04 11:24:49 +0200 | [diff] [blame] | 27 | The file is then going to be moved to the version-independent docs repo. |