Skip to content

[Ignore] Add repro requirements to docs #1630

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 12, 2018
Merged

[Ignore] Add repro requirements to docs #1630

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ad061e
Add repro requirements to docs
rjmholt Dec 6, 2018
92f9d3c
Template note
rjmholt Dec 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,22 @@ When opening an issue, keep in mind:
[tackling an issue], we always accept contributions and will help you
at every step.

## Reproducing the Issue

To fix the issue, we need to be able to reproduce it.
To do that, we need:

- A small/minimal script or sequence of user steps that result in the problem occurring.
- A description of the behavior you are expecting.
- A description of the actual behavior that occurs.

In some cases, a GIF of the issue occuring is also very helpful.

When you open a new issue,
the GitHub issue template will have sections
to guide you through providing all of this information
as well as environment information discussed below.

## Providing Information About Your Environment

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