|
| 1 | +# Issues |
| 2 | + |
| 3 | +* [How to Contribute in Issues](#how-to-contribute-in-issues) |
| 4 | +* [Submitting a Bug Report](#submitting-a-bug-report) |
| 5 | +* [Triaging a Bug Report](#triaging-a-bug-report) |
| 6 | +* [Resolving a Bug Report](#resolving-a-bug-report) |
| 7 | + |
| 8 | +## How to Contribute in Issues |
| 9 | + |
| 10 | +For any issue, there are fundamentally three ways an individual can contribute: |
| 11 | + |
| 12 | +1. By opening the issue for discussion: For instance, if you believe that you |
| 13 | + have uncovered a bug in Project Sample, creating a new issue in the |
| 14 | + issue tracker is the way to report it. |
| 15 | +2. By helping to triage the issue: This can be done either by providing |
| 16 | + supporting details (a test case that demonstrates a bug), or providing |
| 17 | + suggestions on how to address the issue. |
| 18 | +3. By helping to resolve the issue: Typically this is done either in the form |
| 19 | + of demonstrating that the issue reported is not a problem after all, or more |
| 20 | + often, by opening a Pull Request that changes some bit of something in |
| 21 | + in a concrete and reviewable manner. |
| 22 | + |
| 23 | +## Submitting a Bug Report |
| 24 | + |
| 25 | +When opening a new issue in the issue tracker, please provide as much detail about your environment as possible. |
| 26 | + |
| 27 | +See [How to create a Minimal, Complete, and Verifiable example](https://stackoverflow.com/help/mcve). |
| 28 | + |
| 29 | +## Triaging a Bug Report |
| 30 | + |
| 31 | +Once an issue has been opened, it is not uncommon for there to be discussion |
| 32 | +around it. Some contributors may have differing opinions about the issue, |
| 33 | +including whether the behavior being seen is a bug or a feature. This discussion |
| 34 | +is part of the process and should be kept focused, helpful, and professional. |
| 35 | + |
| 36 | +Short, clipped responses—that provide neither additional context nor supporting |
| 37 | +detail—are not helpful or professional. To many, such responses are simply |
| 38 | +annoying and unfriendly. |
| 39 | + |
| 40 | +Contributors are encouraged to help one another make forward progress as much |
| 41 | +as possible, empowering one another to solve issues collaboratively. If you |
| 42 | +choose to comment on an issue that you feel either is not a problem that needs |
| 43 | +to be fixed, or if you encounter information in an issue that you feel is |
| 44 | +incorrect, explain *why* you feel that way with additional supporting context, |
| 45 | +and be willing to be convinced that you may be wrong. By doing so, we can often |
| 46 | +reach the correct outcome much faster. |
| 47 | + |
| 48 | +## Resolving a Bug Report |
| 49 | + |
| 50 | +In the vast majority of cases, issues are resolved by opening a Pull Request. |
| 51 | +The process for opening and reviewing a Pull Request isa similar to that of |
| 52 | +opening and triaging issues, but carries with it a necessary review and approval |
| 53 | +workflow that ensures that the proposed changes meet the minimal quality and |
| 54 | +functional guidelines of the Project Sample project. |
0 commit comments