Clarify 3.0-migration-guide.d/00README
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
This commit is contained in:
parent
e756306dd6
commit
72f762b1da
@ -11,20 +11,17 @@ Who exactly is affected: does this affect users of the default config, of a
|
|||||||
particular feature? Remember to contextualise.
|
particular feature? Remember to contextualise.
|
||||||
|
|
||||||
If I'm affected, what's my migration path? How should I change my code if this
|
If I'm affected, what's my migration path? How should I change my code if this
|
||||||
is and API change; if a feature was removed what are my alternatives?
|
is an API change; if a feature was removed what are my alternatives?
|
||||||
|
|
||||||
Optional: Another Change That Was Made in the Same Pr
|
|
||||||
-----------------------------------------------------
|
|
||||||
|
|
||||||
Who is affected?
|
|
||||||
|
|
||||||
What's the migration path?
|
|
||||||
|
|
||||||
---%<------%<------%<------%<------%<------%<------%<------%<---
|
---%<------%<------%<------%<------%<------%<------%<------%<---
|
||||||
|
|
||||||
|
PRs that make multiple independent changes should include one entry for each
|
||||||
|
changes or logical groups of changes. You can either add multiple files or put
|
||||||
|
multiple entries in the same file.
|
||||||
|
|
||||||
For examples, have a look a docs/3.0-migration-guide.md (which includes the
|
For examples, have a look a docs/3.0-migration-guide.md (which includes the
|
||||||
top-level header and an intro before the list of entries).
|
top-level header and an intro before the list of entries).
|
||||||
|
|
||||||
As part of release preparation, the entries in this directory will be appended
|
As part of release preparation, the entries in this directory will be appended
|
||||||
to docs/3.0-migration-guide.md and then re-ordered and reviewed one last time.
|
to docs/3.0-migration-guide.md and then re-ordered and reviewed one last time.
|
||||||
The file is then going to be moved to the version-independant docs repo.
|
The file is then going to be moved to the version-independent docs repo.
|
||||||
|
Loading…
Reference in New Issue
Block a user