Skip to content

Commit 622a882

Browse files
rjmholtTylerLeonhardt
authored andcommitted
[Ignore] Add repro requirements to docs (#1630)
* Add repro requirements to docs * Template note
1 parent fd8a5db commit 622a882

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/troubleshooting.md

+16
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,22 @@ When opening an issue, keep in mind:
106106
[tackling an issue], we always accept contributions and will help you
107107
at every step.
108108

109+
## Reproducing the Issue
110+
111+
To fix the issue, we need to be able to reproduce it.
112+
To do that, we need:
113+
114+
- A small/minimal script or sequence of user steps that result in the problem occurring.
115+
- A description of the behavior you are expecting.
116+
- A description of the actual behavior that occurs.
117+
118+
In some cases, a GIF of the issue occuring is also very helpful.
119+
120+
When you open a new issue,
121+
the GitHub issue template will have sections
122+
to guide you through providing all of this information
123+
as well as environment information discussed below.
124+
109125
## Providing Information About Your Environment
110126

111127
For solving most issues, the following information is important to provide:

0 commit comments

Comments
 (0)