Skip to content

Commit

Permalink
Update bug report template. Fixes #133
Browse files Browse the repository at this point in the history
  • Loading branch information
Kyle Barron committed Sep 6, 2018
1 parent 95e2e35 commit 5f044bb
Showing 1 changed file with 27 additions and 18 deletions.
45 changes: 27 additions & 18 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,42 @@ about: Create a report to help us improve

---

#### Problem description

- This should explain **why** the current behavior is a problem and why the expected output is a better solution.
- **Note**: Many problems can be resolved by simply upgrading `stata_kernel` to the latest version. Before submitting, please try:

```
pip install stata_kernel --upgrade
```
and check if your issue is fixed.

#### Debugging log

If possible, attach the text file located at

```
$HOME/.stata_kernel_cache/console_debug.log
```
where `$HOME` is your home directory. This will help us debug your problem quicker.

**NOTE: This file includes a history of your session. If you work with restricted data, do not include this file.**

#### Code Sample

<!-- Should be a copy-pastable example if possible -->
Especially if you cannot attach the debugging log, please include a [minimal, complete, and verifiable example.](https://stackoverflow.com/help/mcve)

```stata
// Your code here
```
#### Problem description

<!--
This should explain **why** the current behavior is a problem and why the expected output is a better solution.
**Note**: Many problems can be resolved by simply upgrading `stata_kernel` to the latest version. Before submitting, please check if that solution works for you.
-->

#### Expected Output

#### Debugging log

<!--
If you're using `console` mode, there should be a file named
~/.stata_kernel_cache/console_debug.log. This is helpful to see for debugging
information. Note that this has all the commands and output up to where the
program crashed.
-->
#### Other information

#### Package Version
If you didn't attach the debugging log, please provide:

<!-- You can find the package version with `pip show stata_kernel` -->
- Operating System
- Stata version
- Package version (You can find this by running `pip show stata_kernel` in your terminal.)

0 comments on commit 5f044bb

Please sign in to comment.