Skip to content

Commit 2eeb516

Browse files
committed
Add issue/feature templates
1 parent 16a6b30 commit 2eeb516

File tree

3 files changed

+131
-0
lines changed

3 files changed

+131
-0
lines changed
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
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+
-->

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: False
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature Request
3+
about: Tell us about a new feature that you would like to see in trepan3k
4+
5+
---
6+
7+
## Description
8+
9+
<!-- Add a short description of the feature. This might
10+
include same input and output. -->
11+
12+
## Background
13+
14+
<!-- Add any additional background for the
15+
feature, for example: user scenarios, or the value of the feature. -->
16+
17+
## Priority
18+
19+
<!-- If this is important for a particular public, state that here.
20+
If this is blocking some important activity let us know what activity it blocks.
21+
If you are asking about a release because you are packing for a distribution like Ubuntu or Fedora, BlackArch, say so. I generally make releases otherwise on whim or when I have a need, such as I am giving a talk. If you sponsor, the project your release request has greater importance.
22+
23+
Otherwise, we'll assume whatever is wrong or needed has the lowest priority in addressing.
24+
25+
-->
26+
27+
## Tests
28+
<!-- _This section is optional._
29+
30+
Add text with suggestions on how to test the feature,
31+
if it is not obvious.
32+
-->

0 commit comments

Comments
 (0)