From 72f762b1daad25602818923470bb049f9576655c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Tue, 4 May 2021 11:24:49 +0200 Subject: [PATCH] Clarify 3.0-migration-guide.d/00README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Manuel Pégourié-Gonnard --- docs/3.0-migration-guide.d/00README | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/3.0-migration-guide.d/00README b/docs/3.0-migration-guide.d/00README index dfcf248fa1..031259485a 100644 --- a/docs/3.0-migration-guide.d/00README +++ b/docs/3.0-migration-guide.d/00README @@ -11,20 +11,17 @@ Who exactly is affected: does this affect users of the default config, of a particular feature? Remember to contextualise. 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? - -Optional: Another Change That Was Made in the Same Pr ------------------------------------------------------ - -Who is affected? - -What's the migration path? +is an API change; if a feature was removed what are my alternatives? ---%<------%<------%<------%<------%<------%<------%<------%<--- +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 top-level header and an intro before the list of entries). 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. -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.