Skip to content

Commit b63e0a9

Browse files
chore: use native issue types in templates, add feature request form (#755)
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 3e95b7a commit b63e0a9

3 files changed

Lines changed: 136 additions & 31 deletions

File tree

Lines changed: 56 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,105 @@
11
name: 🐛 Bug report
2-
description: Something on Apollon is not working as expected? Create a report to help us improve.
3-
title: "[BUG] "
4-
labels: ["bug"]
2+
description: Something in Apollon is not working as expected? Let us know so we can fix it.
3+
type: Bug
54
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report a bug. A clear, reproducible report helps us fix it much faster.
9+
10+
- type: checkboxes
11+
id: preflight
12+
attributes:
13+
label: Before you start
14+
options:
15+
- label: I searched the existing issues and discussions and did not find a duplicate.
16+
required: true
17+
- label: I can reproduce this on the live demo (https://apollon.aet.cit.tum.de) or the latest `@tumaet/apollon`.
18+
required: false
19+
620
- type: textarea
721
id: description
822
attributes:
923
label: Describe the bug
1024
description: A clear and concise description of what the bug is.
11-
placeholder: Describe the issue here...
25+
placeholder: When I ..., Apollon ...
1226
validations:
1327
required: true
1428

1529
- type: textarea
1630
id: steps
1731
attributes:
18-
label: To Reproduce
19-
description: Steps to reproduce the behavior.
32+
label: Steps to reproduce
33+
description: Steps for us to reproduce the behaviour. A sample diagram (File → Export → JSON) is very helpful.
2034
placeholder: |
2135
1. Go to '...'
2236
2. Click on '...'
23-
3. Scroll to '...'
24-
4. See error
37+
3. See the error
2538
validations:
2639
required: true
2740

2841
- type: textarea
2942
id: expected
3043
attributes:
31-
label: Expected behavior
32-
description: A clear and concise description of what you expected to happen.
33-
placeholder: What should have happened?
44+
label: Expected behaviour
45+
description: What did you expect to happen instead?
3446
validations:
3547
required: true
3648

37-
- type: textarea
38-
id: screenshots
49+
- type: dropdown
50+
id: area
3951
attributes:
40-
label: Screenshots
41-
description: If applicable, add screenshots to help explain your problem.
42-
placeholder: Drag & drop or paste images here.
52+
label: Area
53+
description: Which part of Apollon is affected? (We will confirm during triage.)
54+
options:
55+
- Editor library
56+
- Standalone web app
57+
- VS Code extension
58+
- Documentation
59+
- Realtime collaboration
60+
- Mobile
61+
- Not sure
62+
validations:
63+
required: false
4364

44-
- type: input
45-
id: os
65+
- type: textarea
66+
id: screenshots
4667
attributes:
47-
label: OS
48-
description: Operating System
49-
placeholder: e.g. iOS, macOS, Windows
68+
label: Screenshots or recording
69+
description: If it helps explain the problem, drag and drop images or a short screen recording here.
5070
validations:
5171
required: false
5272

5373
- type: input
5474
id: browser
5575
attributes:
5676
label: Browser
57-
placeholder: e.g. Chrome, Safari, Firefox
77+
placeholder: e.g. Chrome 126, Safari 17, Firefox 127
5878
validations:
5979
required: false
6080

6181
- type: input
62-
id: version
82+
id: os
6383
attributes:
64-
label: Version
65-
placeholder: e.g. 22
84+
label: Operating system
85+
placeholder: e.g. macOS 14, Windows 11, iOS 17
6686
validations:
6787
required: false
6888

69-
- type: textarea
70-
id: context
89+
- type: input
90+
id: version
7191
attributes:
72-
label: Additional context
73-
description: Add any other context about the problem here.
92+
label: Apollon version
93+
description: If you embed the `@tumaet/apollon` library, which version? (Skip if you used the live demo.)
94+
placeholder: e.g. 4.6.0
95+
validations:
96+
required: false
7497

7598
- type: textarea
7699
id: console
77100
attributes:
78-
label: Web Console Output
79-
description: If applicable, copy output from the Web Console.
101+
label: Browser console output
102+
description: If there are errors, copy them from the browser dev tools console.
80103
render: shell
104+
validations:
105+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 Questions & ideas (Discussions)
4+
url: https://github.com/ls1intum/Apollon/discussions
5+
about: Have a question or want to discuss an idea before filing? Start here.
6+
- name: ▶ Try the live demo
7+
url: https://apollon.aet.cit.tum.de
8+
about: Reproduce or explore the editor in your browser.
9+
- name: 📖 Documentation
10+
url: https://ls1intum.github.io/Apollon/
11+
about: Guides, API reference, and embedding examples.
12+
- name: 🔒 Report a security vulnerability
13+
url: https://github.com/ls1intum/Apollon/security/advisories/new
14+
about: Please report security issues privately, not as a public issue.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: 💡 Feature request
2+
description: Suggest an idea or new capability for Apollon.
3+
type: Feature
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for sharing an idea. Tell us about the problem first and the solution second — it helps us understand the need even if we end up solving it differently.
9+
10+
- type: checkboxes
11+
id: preflight
12+
attributes:
13+
label: Before you start
14+
options:
15+
- label: I searched the existing issues and discussions and did not find a duplicate.
16+
required: true
17+
18+
- type: textarea
19+
id: problem
20+
attributes:
21+
label: What problem would this solve?
22+
description: What are you trying to do, and where does Apollon get in the way today?
23+
placeholder: I'm trying to ... but ...
24+
validations:
25+
required: true
26+
27+
- type: textarea
28+
id: proposal
29+
attributes:
30+
label: Proposed solution
31+
description: What would you like to see? Describe the behaviour or capability you have in mind.
32+
placeholder: It would help if Apollon could ...
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: alternatives
38+
attributes:
39+
label: Alternatives considered
40+
description: Any workarounds or other approaches you have thought about.
41+
validations:
42+
required: false
43+
44+
- type: dropdown
45+
id: area
46+
attributes:
47+
label: Area
48+
description: Which part of Apollon does this relate to? (We will confirm during triage.)
49+
options:
50+
- Editor library
51+
- Standalone web app
52+
- VS Code extension
53+
- Documentation
54+
- Realtime collaboration
55+
- Mobile
56+
- Not sure
57+
validations:
58+
required: false
59+
60+
- type: textarea
61+
id: context
62+
attributes:
63+
label: Additional context
64+
description: Mockups, links, or anything else that helps explain the idea.
65+
validations:
66+
required: false

0 commit comments

Comments
 (0)