Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 17:08:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 83

Add "Why use short and simple issue templates?" section (#13355)

Browse source 
resolves issue #13327 

Adds a section laying out the reasoning behind short/simple issue
templates

---------

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
This commit is contained in:
daniellegk 2023-08-26 19:23:59 -05:00 committed by GitHub
parent f9224623df
commit 0d43353356
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
handbook/company/why-this-way.md
View file

@ -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?