From dffba7437bd98d9497f111b218f776d434ac8bc2 Mon Sep 17 00:00:00 2001 From: Rachael Shaw Date: Wed, 1 May 2024 12:17:11 -0500 Subject: [PATCH] Update drafting process for API changes (#18619) Proposes a solution to avoid messing with the PR open time KPI when creating API design draft PRs. (These PRs are created fairly often as part of the normal product design process, and usually sit in draft for weeks before they're ready to merge.) See conversation [here](https://github.com/fleetdm/fleet/pull/16129#issuecomment-2080181953) for context. --- handbook/product-design/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/handbook/product-design/README.md b/handbook/product-design/README.md index a224150441..af31d259ee 100644 --- a/handbook/product-design/README.md +++ b/handbook/product-design/README.md @@ -49,7 +49,8 @@ When starting a new draft: - **Ready.** Use this page to communicate designs reviews and development. - **Scratchpad.** Use this page for work in progress and design that might be useful in the future. - If the story requires API changes, open a draft PR with the proposed API design. - + - These draft PRs are not actually merged, since they're often created weeks ahead of implementation and can artificially affect our PR open time KPI. Instead, once the documentation changes are ready for final review, the designer closes the draft PR and opens a fresh PR from the same branch. + ### Schedule a design review - Prepare your draft in the user story issue. - Prepare the agenda for your design review meeting, which should be an empty document other than the proposed changes you will present.