Skip to content

Commit 3bb0470

Browse files
committed
templates: switch to issue forms
Replace the legacy issue template with separate issue forms for bug reports and feature requests. Also add an "ask a question" contact link that points to openslide-users, and disallow creating issues from a blank template to encourage use of the correct reporting channel. Signed-off-by: Benjamin Gilbert <[email protected]>
1 parent 9cbabf5 commit 3bb0470

File tree

4 files changed

+65
-11
lines changed

4 files changed

+65
-11
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Bug report
2+
description: Report an bug in OpenSlide Python
3+
labels: ["defect"]
4+
body:
5+
- type: input
6+
id: os
7+
attributes:
8+
label: Operating system
9+
placeholder: e.g. Fedora 37, macOS 12, Windows 11
10+
validations:
11+
required: true
12+
- type: input
13+
id: platform
14+
attributes:
15+
label: Platform
16+
placeholder: e.g. 64-bit x86, 32-bit ARM
17+
validations:
18+
required: true
19+
- type: input
20+
id: version
21+
attributes:
22+
label: OpenSlide Python version
23+
description: "`openslide.__version__`"
24+
validations:
25+
required: true
26+
- type: input
27+
id: openslide-version
28+
attributes:
29+
label: OpenSlide version
30+
description: "`openslide.__library_version__`"
31+
validations:
32+
required: true
33+
- type: input
34+
id: format
35+
attributes:
36+
label: Slide format
37+
placeholder: e.g. SVS, NDPI, MRXS
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: details
42+
attributes:
43+
label: Issue details
44+
placeholder: Describe your issue
45+
validations:
46+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask a question
4+
url: https://lists.andrew.cmu.edu/mailman/listinfo/openslide-users/
5+
about: Ask support questions on the openslide-users mailing list

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Feature request
2+
description: Request an enhancement to OpenSlide Python
3+
labels: ["enhancement"]
4+
body:
5+
- type: input
6+
id: format
7+
attributes:
8+
label: Slide format
9+
placeholder: e.g. SVS, NDPI, MRXS
10+
- type: textarea
11+
id: details
12+
attributes:
13+
label: Issue details
14+
placeholder: Describe your issue

0 commit comments

Comments
 (0)