Skip to content

Commit

Permalink
doc: improve triaging text in issues.md
Browse files Browse the repository at this point in the history
Remove a double negative and many superfluous sentences. The sentiment
in the removed material is good, but we already tell people that
discussion should be focused, helpful, and professional. Having two
extra paragraphs greatly reduces the likelihood that people will read
the material.

PR-URL: #34164
Reviewed-By: Anto Aravinth <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
Trott authored and MylesBorins committed Jul 16, 2020
1 parent 22c1fbf commit 9f0bf5c
Showing 1 changed file with 1 addition and 13 deletions.
14 changes: 1 addition & 13 deletions doc/guides/contributing/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,23 +84,11 @@ See [How to create a Minimal, Complete, and Verifiable example](https://stackove

## Triaging a Bug Report

Once an issue has been opened, it is not uncommon for there to be discussion
Once an issue has been opened, it is common for there to be discussion
around it. Some contributors may have differing opinions about the issue,
including whether the behavior being seen is a bug or a feature. This discussion
is part of the process and should be kept focused, helpful, and professional.

Short, clipped responses that provide neither additional context nor supporting
details are not helpful or professional to many. Such responses are simply
annoying and unfriendly.

Contributors are encouraged to help one another to make forward progress as much
as possible, empowering one another to solve issues collaboratively. If you
choose to comment on an issue that you feel either is not a problem that needs
to be fixed, or if you encounter information in an issue that you feel is
incorrect, explain *why* you feel that way with additional supporting context,
and be willing to be convinced that you may be wrong. By doing so, we can often
reach the correct outcome much faster.

## Resolving a Bug Report

In the vast majority of cases, issues are resolved by opening a Pull Request.
Expand Down

0 comments on commit 9f0bf5c

Please sign in to comment.