From 0d433533569ed35181a546112d659a2ccf4a4e92 Mon Sep 17 00:00:00 2001 From: daniellegk <141519996+daniellegk@users.noreply.github.com> Date: Sat, 26 Aug 2023 19:23:59 -0500 Subject: [PATCH] Add "Why use short and simple issue templates?" section (#13355) resolves issue #13327 Adds a section laying out the reasoning behind short/simple issue templates --------- Co-authored-by: Mike McNeil --- handbook/company/why-this-way.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/handbook/company/why-this-way.md b/handbook/company/why-this-way.md index 8669e87d78..6b9c746162 100644 --- a/handbook/company/why-this-way.md +++ b/handbook/company/why-this-way.md @@ -236,6 +236,16 @@ If that happens by mistake, first priority is merging a fix, then notifying the > Here is [an example of a deliberate decision to make broken images in Fleet fail more loudly](https://github.com/fleetdm/fleet/issues/12305#issuecomment-1671924257) so that they can't be overlooked, even though this might slow down short-term development. +## Why keep issue templates simple? +At Fleet, we optimize for the person submitting the issue, not the person receiving it. + +We avoid making the submitter read anything. We prompt for as little information as possible. Why? +- When someone is submitting an issue, they are usually in a hurry. They [might not even work here](https://fleetdm.com/handbook/company/why-this-way#why-open-source). Even short issue templates can cause confusion, lead to mistakes, and discourage future submissions. +- The person receiving an issue has more context, and so will have an easier time filling in the gaps and, if necessary, following up to better understand. +- This encourages [everyone to contribute](https://fleetdm.com/handbook/company#openness), and [keep contributing](https://fleetdm.com/handbook/company#results). + +For example, here is the [philosophy behind Fleet's bug report template](https://github.com/fleetdm/fleet/pull/13204#issuecomment-1678419117). + ## Why don't we sell like everyone else?