|
| 1 | +--- |
| 2 | +name: Bug report |
| 3 | +about: Tell us about trepan3k bugs |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +<!-- |
| 8 | +Bugs are also not for general or novice kind help on how to install |
| 9 | +this Python program in your environment in the way you would like to |
| 10 | +have it set up, or how to interpret a Python traceback. |
| 11 | +
|
| 12 | +For these kinds of things, you will save yourself time by asking |
| 13 | +instead on forums like StackOverflow that are geared to helping people |
| 14 | +for such general or novice kinds questions and tasks. |
| 15 | +
|
| 16 | +Unless you are a sponsor of the project, it could take a while before |
| 17 | +the bug report is noticed. Bug reports that don't follow instructions |
| 18 | +here, or look like little thought and effort put into reporting a |
| 19 | +problem, may be met with the same quality of thought can care in |
| 20 | +response. |
| 21 | +
|
| 22 | +To set expectations, some legitimate bugs can take years to fix, but |
| 23 | +they eventually do get fixed. |
| 24 | +
|
| 25 | +Funding the project was added to partially address the problem that |
| 26 | +there are lots of people seeking help and reporting bugs, but few |
| 27 | +people who are willing or capable of providing help or fixing bugs. |
| 28 | +
|
| 29 | +--> |
| 30 | + |
| 31 | +## Description |
| 32 | + |
| 33 | +<!-- Please add a clear and concise description of the bug. Try to |
| 34 | +narrow the problem down to the smallest that exhibits the bug.--> |
| 35 | + |
| 36 | +## How to Reproduce |
| 37 | + |
| 38 | +<!-- Please show both the *input* you gave and the |
| 39 | +output you got in describing how to reproduce the bug: |
| 40 | +
|
| 41 | +or give a complete console log with input and output |
| 42 | +
|
| 43 | +```console |
| 44 | +$ trepan3k <command-line-options> |
| 45 | +... |
| 46 | +$ |
| 47 | +``` |
| 48 | +
|
| 49 | +Provide links to the Python bytecode. For example, you can create a |
| 50 | +gist with the information. If you have the correct source code, you |
| 51 | +can add that too. |
| 52 | +
|
| 53 | +--> |
| 54 | + |
| 55 | +## Output Given |
| 56 | + |
| 57 | +<!-- |
| 58 | +Please include not just the error message but all output leading to the message which includes echoing input and messages up to the error. |
| 59 | +For a command-line environment include command invocation and all the output produced. |
| 60 | +
|
| 61 | +If this is too long, then try narrowing the problem to something short. |
| 62 | +--> |
| 63 | + |
| 64 | + |
| 65 | +## Expected behavior |
| 66 | + |
| 67 | +<!-- Add a clear and concise description of what you expected to happen. --> |
| 68 | + |
| 69 | +## Environment |
| 70 | + |
| 71 | +<!-- _This section sometimes is optional but helpful to us._ |
| 72 | +
|
| 73 | +Please modify for your setup |
| 74 | +
|
| 75 | +- trepan3k version: output from `trepan3k --version` or `pip show trepan3k` |
| 76 | +- Python environment you are using. |
| 77 | +
|
| 78 | +--> |
| 79 | + |
| 80 | +## Workarounds |
| 81 | + |
| 82 | +<!-- If there is a workaround for the problem, describe that here. --> |
| 83 | + |
| 84 | +## Priority |
| 85 | + |
| 86 | +<!-- If this is important for a particular public good state that here. |
| 87 | + If this is blocking some important activity let us know what activity it blocks. |
| 88 | +
|
| 89 | + Otherwise, we'll assume this has the lowest priority in addressing. |
| 90 | + --> |
| 91 | + |
| 92 | +## Additional Context |
| 93 | + |
| 94 | +<!-- _This section is optional._ |
| 95 | +
|
| 96 | +Add any other context about the problem here or special environment setup. |
| 97 | +
|
| 98 | +--> |
0 commit comments