Skip to content

Commit f887447

Browse files
authored
Update issue templates
Add report template for commands
1 parent 85eac9e commit f887447

File tree

2 files changed

+161
-0
lines changed

2 files changed

+161
-0
lines changed
Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
name: Commands Functionality Bug Report
3+
about: Report core functionality bugs like a command not running or yielding wrong
4+
result
5+
title: ''
6+
labels: bug
7+
assignees: mpourmpoulis
8+
9+
---
10+
11+
## Description
12+
13+
<!-- here you can provide your description of the bug.
14+
15+
Providing the screenshot or GIF could be helpful if things are complicated. Furthermore,there follows a small questionnaire to help you summarize information about some important aspects you may have noticed about the issue
16+
To complete you can fill the checkboxes with "x" or click them after you submit the issue.
17+
Zero,one or more answers may be applicable for each question!
18+
19+
-->
20+
21+
**General Information**
22+
<!-- which version are you using? for instance v0.1.0, v0.1.2 or develop -->
23+
24+
Plug-In Version:
25+
26+
**Queries Affected**
27+
28+
<!-- what types of queries are affected (there may be multiple) -->
29+
30+
- [ ] Argument
31+
32+
- [ ] Big Roi
33+
34+
- [ ] Sub Indexing
35+
- [ ] only dedicated Subindexing commands
36+
- [ ] also affect suffixes
37+
38+
- [ ] Operations
39+
- [ ] Paste
40+
- [ ] Delete
41+
- [ ] Swap
42+
- [ ] Edit
43+
- [ ] Prefix
44+
45+
- [ ] Collections
46+
47+
48+
**Response To Command**
49+
50+
<!-- okay what is actually happening? -->
51+
52+
- [ ] the command fails/nothing happens at all
53+
54+
- [ ] the command select/operates on a wrong result,
55+
- [ ] that did not match your positional description (e.g. grabs an ROI one line above or below the one you wanted)
56+
- [ ] did not match the type of result you are looking for(e.g. you wanted an assertion message but you got assertion condition)
57+
- [ ] or maybe the result was of the correct type and position but it was selected improperly(e.g. you asked for the parameter list of function but the last parameter was not selected)
58+
- [ ] or maybe things are working fine when trying to select a region as a whole but start breaking when you try access smaller pieces of it
59+
- [ ] or perhaps the command did find the correct result but perhaps the alternatives included regions they should not or vice versa. (for instance because the command searched the entire code instead of just the current function or vice versa)
60+
61+
- [ ] somehow the whole preserving the current state(alternatives,origin,initial_origin and so on) was messed up by the command! For instance,
62+
- [ ] track was lost of initial originand things were pasted back onto the wrong position
63+
- [ ] alternatives were changed when they were supposed not to!(for instance prefix operations are not supposed to do this)
64+
65+
66+
- [ ] the command seems to select/operates on a random result
67+
68+
- [ ] the command has some other unintended behavior
69+
70+
71+
72+
73+
**Context In Which It Appears**
74+
75+
<!--
76+
Unfortunately, bugs can sometimes appear only in a specific context making them harder to reproduce and debug. There is no need for you to scratch your head and go through over every scenario presented here but if you have noticed any of the below it could help me narrow things down!
77+
-->
78+
79+
Does the problem seem to appear or disappear only some of the time? Does there seem to be
80+
81+
- [ ] spatial context/correlation with the cursor? for instance
82+
- [ ] is it affected by adjustments to the cursor position?()
83+
- [ ] does it make a difference whether you have selected some text or not?
84+
- [ ] does the problem appear only when you're going in one direction?
85+
- [ ] does it have to only do with multiple cursors?
86+
- [ ] or perhaps when switching back-and-forth between single and multiple cursors?
87+
88+
89+
90+
- [ ] a temporal context?
91+
- [ ] does it appear only right after selection query was executed?
92+
- [ ] does it appear only if no one other selection query was executed since the last edit?
93+
- [ ] does it appear only after executing an operation(paste,delete,swap)?
94+
- [ ] does it appear when you perform manual editing between commands?
95+
96+
- [ ] correlation with a pattern in the code? a strong indicator for such a case . In case you have identified this pattern, does the error occure when it appears
97+
- [ ] on the target of the query? (For instance there was a bug at some point that sometimes prevented you from selecting arguments from function calls inside with statements)
98+
- [ ] on the origin of the query?
99+
- [ ] in between them perhaps?
100+
- [ ] somewhere inside to the current function/class/indentation block/...
101+
- [ ] anywhere in the code :)
102+
103+
<!-- if none of the above satisfies you can describe the contextas you wish -->
104+
105+
<!-- I did some examples(like providing gifs, code snippets, command series) where things work versus when they don't could sometimes be helpful especially when you're not really sure what is wrong. -->
106+
107+
**Error Message**
108+
109+
- [ ] error message appears in a pop-up
110+
111+
- [ ] an exception trace back is printed in the sublime console(Ctrl + \`)
112+
113+
- [ ] the command fails silently
114+
115+
<!-- If possible, sharing the error message might be helpful
116+
```
117+
error message
118+
```
119+
-->
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Core Functionality Bug Report
3+
about: Report core functionality bugs like a command not running or yielding wrong
4+
result
5+
title: ''
6+
labels: ''
7+
assignees: ''
8+
9+
---
10+
11+
## Description
12+
13+
14+
**Queries Affected**
15+
16+
- [ ] Argument
17+
18+
- [ ] Big Roi
19+
20+
- [ ] Sub Indexing
21+
22+
- [ ] Operations
23+
24+
- [ ] Collections
25+
26+
27+
**Response To Command**
28+
29+
- [ ] nothing happens at all
30+
31+
**Error Message**
32+
33+
- [ ] error message appears in a pop-up
34+
35+
- [ ] an exception trace back is printed in the sublime console(Ctrl + \`)
36+
37+
- [ ] the command fails silently
38+
39+
40+
## Steps To Reproduce
41+
42+
<-- -->

0 commit comments

Comments
 (0)