Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

Commit 88e7a64

Browse files
chore: issue templates for annotations (#686)
* chore: issue template for missing annotations * chore: fix syntax error * chore: remove empty title * chore: fix placeholder? * chore: fix placeholder * chore: minor improvements * chore: issue template for wrong annotations * Rename wrong_annotation to wrong_annotation.yml * style: apply automatic fixes of linters Co-authored-by: Lukas Radermacher <[email protected]>
1 parent b99ea82 commit 88e7a64

File tree

2 files changed

+127
-0
lines changed

2 files changed

+127
-0
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: 'Missing annotation (autogen)'
2+
description: "An annotation should have been generated automatically but wasn't."
3+
labels: ['bug', 'missing annotation']
4+
5+
body:
6+
- type: input
7+
id: url-hash
8+
attributes:
9+
label: URL Hash
10+
description: Copy the part of the URL that starts with `#` from the address bar of your browser.
11+
placeholder: 'ex. #/sklearn/sklearn.metrics'
12+
validations:
13+
required: true
14+
15+
- type: dropdown
16+
id: expected-annotation-type
17+
attributes:
18+
label: Expected Annotation Type
19+
description: Which annotation did you expect to be generated automatically?
20+
options:
21+
- '@boundary'
22+
- '@constant'
23+
- '@enum'
24+
- '@optional'
25+
- '@remove'
26+
- '@required'
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: expected-annotation-inputs
32+
attributes:
33+
label: Expected Annotation Inputs
34+
description: Which inputs did you expect the annotation to have?
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: suggested-solution
40+
attributes:
41+
label: Suggested Solution (optional)
42+
description: Do you already have an idea how this problem could be fixed?
43+
validations:
44+
required: false
45+
46+
- type: textarea
47+
id: additional-context
48+
attributes:
49+
label: Additional Context (optional)
50+
description: Do you have anything else to add?
51+
validations:
52+
required: false
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: 'Wrong annotation (autogen)'
2+
description: 'An annotation was generated automatically but is incorrect.'
3+
labels: ['bug', 'wrong annotation']
4+
5+
body:
6+
- type: input
7+
id: url-hash
8+
attributes:
9+
label: URL Hash
10+
description: Copy the part of the URL that starts with `#` from the address bar of your browser.
11+
placeholder: 'ex. #/sklearn/sklearn.metrics'
12+
validations:
13+
required: true
14+
15+
- type: dropdown
16+
id: actual-annotation-type
17+
attributes:
18+
label: Actual Annotation Type
19+
description: Which annotation was generated automatically?
20+
options:
21+
- '@boundary'
22+
- '@constant'
23+
- '@enum'
24+
- '@optional'
25+
- '@remove'
26+
- '@required'
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: actual-annotation-inputs
32+
attributes:
33+
label: Actual Annotation Inputs
34+
description: Which inputs did the automatically generated annotation have?
35+
validations:
36+
required: true
37+
38+
- type: dropdown
39+
id: expected-annotation-type
40+
attributes:
41+
label: Expected Annotation Type
42+
description: Which annotation did you expect to be generated automatically?
43+
options:
44+
- '@boundary'
45+
- '@constant'
46+
- '@enum'
47+
- '@optional'
48+
- '@remove'
49+
- '@required'
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: expected-annotation-inputs
55+
attributes:
56+
label: Expected Annotation Inputs
57+
description: Which inputs did you expect the annotation to have?
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: suggested-solution
63+
attributes:
64+
label: Suggested Solution (optional)
65+
description: Do you already have an idea how this problem could be fixed?
66+
validations:
67+
required: false
68+
69+
- type: textarea
70+
id: additional-context
71+
attributes:
72+
label: Additional Context (optional)
73+
description: Do you have anything else to add?
74+
validations:
75+
required: false

0 commit comments

Comments
 (0)