Skip to content

Commit 9205a0e

Browse files
authored
Create performance.yml
1 parent 3344cb2 commit 9205a0e

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed
Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: 'Performance Report'
2+
description: 'Report performance issues with QuickShop.'
3+
4+
title: '[PERFORMANCE] '
5+
labels:
6+
- 'performance'
7+
8+
body:
9+
- type: 'markdown'
10+
attributes:
11+
value: |-
12+
## Please Read!
13+
This Form is reserved for **Performance reports only!**
14+
15+
- For Bugs or issues with QuickShop, open a [Bug Report](https://github.com/Ghost-chu/QuickShop-Reremake/issues/new?template=bug_report.yml&labels=performance).
16+
- For contributions towards the wiki, open a [Wiki Contribution](https://github.com/Ghost-chu/QuickShop-Reremake/issues/new?template=wiki_contribution.yml.yml&labels=wiki).
17+
- Feature requests or other suggestions should be made in the [Discussions](https://github.com/Ghost-chu/QuickShop-Reremake/discussions).
18+
19+
Please fill out all required fields in their entirety and as details as possible. Failing to do so could get your issue closed without any warning.
20+
21+
#### Additional Notes
22+
Please only provide Sampler results from [Spark](https://www.spigotmc.org/resources/57242/)! Spigot Timings - no matter if v1 or v2 - will be ignored.
23+
Your issue will be closed without any reply if only a Spigot Timings Report was provided.
24+
- type: 'textarea'
25+
attributes:
26+
label: 'Description'
27+
description: |-
28+
Describe the issue as detailed as possible.
29+
You cann upload screenshots of the issue in the "screenshots" section further down.
30+
placeholder: 'When I used Quickshop did ... happen.'
31+
validations:
32+
required: true
33+
- type: 'textarea'
34+
attributes:
35+
label: 'Steps to reproduce'
36+
description: 'List your steps on how to reproduce this issue reliably here.'
37+
placeholder: |-
38+
1. Do something
39+
2. ...
40+
3. Bad performance!
41+
validations:
42+
required: true
43+
- type: 'textarea'
44+
attributes:
45+
label: 'Expected Behaviour'
46+
description: 'What did you expect QuickShop to do?'
47+
placeholder: 'QuickShop should ...'
48+
validations:
49+
required: true
50+
- type: 'textarea'
51+
attributes:
52+
label: 'Screenshots'
53+
description: |-
54+
Provide screenshots to show the performance problems, if possible.
55+
Gifs or Videos are also welcome if they can help explaining the issue.
56+
placeholder: 'When I used Quickshop did ... happen.'
57+
validations:
58+
required: true
59+
- type: 'input'
60+
attributes:
61+
label: '`/qs paste` URL'
62+
description: |-
63+
Please execute `/qs paste` in-game or `qs paste` in your server console.
64+
The plugin will generate a URL that you can then post in the field below.
65+
66+
If you can't create a paste, should you upload other files such as the `latest.log` file to https://paste.helpch.at and share the URL.
67+
68+
If QuickShop is unable to generate a Paste will it create a file under `plugins/QuickShop/`
69+
placeholder: 'https://paste.ubuntu.com/p/abc123/'
70+
validations:
71+
required: true
72+
- type: 'input'
73+
attributes:
74+
label: 'Spark Sample URL'
75+
description: |-
76+
**How to use [Spark](https://www.spigotmc.org/resources/57242/)**
77+
78+
1. Download the plugin from the Spigot page (linked above) if you haven't already.
79+
2. Add it to the server like any other plugin (Stop Server, add jar, start server).
80+
3. Join the server and execute `/spark sampler --start`
81+
4. Wait at least 10 minutes and/or perform the actions that cause performance issues with QuickShop.
82+
5. Execute `/spark sampler --stop` to get the URL
83+
6. Paste the URL in the field below.
84+
validations:
85+
required: true
86+
- type: 'textarea'
87+
attributes:
88+
label: 'Additional Context'
89+
description: 'Feel free to include any info that may not fit any of the previous sections.'
90+
placeholder: 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam ...'

0 commit comments

Comments
 (0)