Skip to content

Commit 99da168

Browse files
Add issue templates (stfc#581)
Co-authored-by: ElliottKasoar <[email protected]>
1 parent 24c46f1 commit 99da168

File tree

4 files changed

+100
-0
lines changed

4 files changed

+100
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Summary
8+
description: |
9+
A clear and concise description of the bug, including a minimal reproducible example.
10+
11+
Please include your full output with the complete error message.
12+
validations:
13+
required: true
14+
15+
- type: input
16+
attributes:
17+
label: Platform
18+
description: What operating system and architecture are you using? (see `uname -orsm` on Linux/MacOS)
19+
placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64
20+
validations:
21+
required: true
22+
23+
- type: input
24+
attributes:
25+
label: Version
26+
description: What version of janus-core are you using? (see `janus --version`)
27+
placeholder: "e.g., janus-core version: 0.8.3"
28+
validations:
29+
required: true
30+
31+
- type: input
32+
attributes:
33+
label: Python version
34+
description: What version of Python are you using? (see `python3 --version`)
35+
placeholder: e.g., Python 3.12.6
36+
validations:
37+
required: false
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Summary
8+
description: |
9+
A clear and concise description of what new feature or behaviour you would like to see. If applicable, please describe the current behaviour as well.
10+
validations:
11+
required: true
12+
13+
- type: textarea
14+
attributes:
15+
label: Example
16+
description: Provide an example of how the user experience would change or how the new feature would be used.
17+
validations:
18+
required: false
19+
20+
- type: textarea
21+
attributes:
22+
label: Alternatives
23+
description: A clear and concise description of any alternative solutions or features you've considered.
24+
validations:
25+
required: false
26+
27+
- type: textarea
28+
attributes:
29+
label: Additional context
30+
description: Add any other context or screenshots about the feature request here.
31+
validations:
32+
required: false
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Question
2+
description: Ask a question about janus-core
3+
labels: ["question"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Question
8+
description: Describe your question in detail.
9+
validations:
10+
required: true
11+
12+
- type: input
13+
attributes:
14+
label: Platform
15+
description: What operating system and architecture are you using? (see `uname -orsm` on Linux/MacOS)
16+
placeholder: e.g., macOS 14 arm64, Windows 11 x86_64, Ubuntu 20.04 amd64
17+
validations:
18+
required: false
19+
20+
- type: input
21+
attributes:
22+
label: Version
23+
description: What version of janus-core are you using? (see `janus --version`)
24+
placeholder: "e.g., janus-core version: 0.8.3"
25+
validations:
26+
required: false

.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: true
2+
contact_links:
3+
- name: Documentation
4+
url: https://stfc.github.io/janus-core/
5+
about: Please consult the documentation before creating an issue.

0 commit comments

Comments
 (0)