From 84562ffc49720d7d5b49e3daa61b6ecc6516ff5b Mon Sep 17 00:00:00 2001 From: rosstimothy <39066650+rosstimothy@users.noreply.github.com> Date: Mon, 13 Mar 2023 15:03:23 -0400 Subject: [PATCH] Adds the following sections to the RFD template: (#22993) #### Proto Specification - This ensures that all api changes are reviewed during the design and not in a subsequent PR. This is also more closely aligns with the design process we force on interview candidates. #### Backward Compatibility - Forces RFD authors to consider how there changes will interact with older clusters and clients. Any migration steps should be called out directly in the RFD so that when the feature is rolled out there are no surprises. #### Test Plan - Causes the authors to think about what quality assurance measures need to be in place to catch regressions before they happen. The same testing should also occur prior to the initial release that the feature will land in if said release isn't a major release. --- rfd/0000-rfds.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/rfd/0000-rfds.md b/rfd/0000-rfds.md index 1eec77ef0c9..6f0ecd584bf 100644 --- a/rfd/0000-rfds.md +++ b/rfd/0000-rfds.md @@ -146,3 +146,27 @@ Describe the UX changes and impact of your design doc. recover * Consider the UX of configuration changes and their impact on Teleport upgrades * Consider the UX scenarios for Cloud users + + +### Proto Specification + +Include any `.proto` changes or additions that are necessary for your design. + + +### Backward Compatibility + +Describe the impact that your design doc has on backwards compatibility and +include any migration steps. +(Non-exhaustive list below.) + +* Will the change impact older clients? (tsh, tctl) +* What impact does the change have on remote clusters? +* Are there any backend migrations required? +* How will changes be rolled out across future versions? + +### Test Plan + +Include any changes or additions that will need to be made to +the [Test Plan](../.github/ISSUE_TEMPLATE/testplan.md) to appropriately +test the changes in your design doc and prevent any regressions from +happening in the future. \ No newline at end of file