Skip to content

Commit 3068159

Browse files
gablmCryotechnic
gablm
and
Cryotechnic
committed
Add PR & Issue Templates
Co-Authored-By: Ron Friedman <9833218+Cryotechnic@users.noreply.github.com>
1 parent d29f36e commit 3068159

File tree

4 files changed

+177
-0
lines changed

4 files changed

+177
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
name: Bug Report
3+
description: Create a report to help us fix the Duet Night Abyss Plugin for Collapse!
4+
title: "[Bug]: "
5+
labels: ['Needs Triaging']
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for trying to help us make Collapse better for everyone!
11+
Before filling anything out, please make sure that there **aren't** any open/closed issues for this topic & that this is *reproducible*.
12+
All text areas support markdown syntax unless explicitly noted otherwise.
13+
14+
- type: input
15+
id: affected-plugin-version
16+
attributes:
17+
label: Affected Version
18+
description: Plugin Version where the bug was encountered.
19+
placeholder: e.g. 0.6.0
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: affected-launcher-version
25+
attributes:
26+
label: Affected Version
27+
description: Launcher Version where the bug was encountered.
28+
placeholder: e.g. Collapse 1.83.13
29+
validations:
30+
required: true
31+
32+
- type: markdown
33+
attributes:
34+
value: |
35+
### System Information
36+
Please attach a copy of `dxdiag.txt` to this issue so that we can better understand your hardware configuration: "Save all information" (Run > Type `dxdiag` then enter > Save all information > Then Drag & Drop the file to your issue, or attach it through the file selection dialog).
37+
38+
- type: markdown
39+
attributes:
40+
value: |
41+
### Console Log
42+
Paste the log inside a code block here or attach the log file here. By default, the location for the log file is `C:\Users\%username%\AppData\LocalLow\CollapseLauncher\_logs` The latest log will be today's date, or the date of the last time you launched Collapse.
43+
44+
- type: textarea
45+
id: bug-behavior
46+
attributes:
47+
label: Bug Behavior
48+
description: Describe the encountered bug with as much detail as possible.
49+
placeholder: What happened?
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: expected-behavior
55+
attributes:
56+
label: Expected Behavior
57+
description: Describe how Collapse and/or the plugin should have behaved, being as detailed as possible in your answer.
58+
placeholder: What should have happened?
59+
validations:
60+
required: true
61+
62+
- type: textarea
63+
id: reproduction-steps
64+
attributes:
65+
label: Steps to reproduce
66+
description: Describe the steps you took to reproduce the bug, with as much detail as possible.
67+
placeholder: |
68+
1. [First step]
69+
2. [Second step]
70+
3. [so on...]
71+
validations:
72+
required: true
73+
74+
- type: input
75+
id: related-issues
76+
attributes:
77+
label: Related Issues
78+
description: If this issue affects other issues or has the potential to, mark it here.
79+
placeholder: e.g. `#144`
80+
81+
- type: textarea
82+
id: screenshots
83+
attributes:
84+
label: Screenshot(s)
85+
description: If this issue affects a visual component (UI element) of Collapse, please paste the relevant screenshots, recordings and GIFs here.
86+
87+
- type: textarea
88+
id: additional-info
89+
attributes:
90+
label: Additional Information
91+
description: If you have anything else to add that may help with resolving the issue (logs, dumps, comments, etc.), feel free to leave them here.
92+
---

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: Feature/Enhancement request
3+
description: Suggest an idea for new feature or changes.
4+
title: "[Request]: "
5+
labels: ['Enhancement']
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This is the Feature and/or Enhancement request form for the Duet Night Abyss plugin. Before filling it out, please make sure that there are **no open/closed issues** regarding your request. All text areas support markdown syntax unless explicitly noted otherwise. We will close the issue if it is a duplicate.
11+
12+
- type: dropdown
13+
id: is-related
14+
attributes:
15+
label: Is your request related to a problem?
16+
description: This can take the form of an improvement that fixes an issue in Collapse
17+
options:
18+
- 'Yes'
19+
- 'No'
20+
default: 1
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: related-desc
26+
attributes:
27+
label: How is the feature request related to the problem?
28+
description: If you answered "No" to the previous question, you may skip this field.
29+
placeholder: Explain how the feature is related to the problem, if it is related.
30+
validations:
31+
required: false
32+
33+
- type: textarea
34+
id: solution-desc
35+
attributes:
36+
label: Describe your proposed solution
37+
description: A clear and concise description of what you want to happen.
38+
placeholder: Go into as much detail as possible.
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: alternative-desc
44+
attributes:
45+
label: Describe alternatives you've considered
46+
description: A clear and concise description of any alternative solutions or features you've considered.
47+
placeholder: What are the alternatives you've considered? Sometimes, the Collapse team can't always implement everything the way you envisioned it, so what are some compromises, changes you're willing to make to the current proposal?
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: additional-context
53+
attributes:
54+
label: Additional context
55+
description: Add any other context or screenshots about the feature request here.
56+
placeholder: If there are any images, concept art, code snippets you're willing to share, please put them here.
57+
validations:
58+
required: false
59+
---

‎.github/pull_request_template.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Main Goal
2+
{Describe/list your goal for the PR here}
3+
4+
## PR Status :
5+
- Overall Status : Done/In Progress/Stalled/Cancelled
6+
- Commits : Done/In Progress/Stalled/Cancelled
7+
- Synced to base (Collapse:main) : Yes/Not yet
8+
- Build status : OK/Crashing/Build Errors
9+
- Crashing : Yes/No
10+
- Bug found caused by PR : {int}
11+
12+
### Templates
13+
14+
<details>
15+
<summary>Changelog Prefixes</summary>
16+
17+
```
18+
**[New]**
19+
**[Imp]**
20+
**[Fix]**
21+
**[Loc]**
22+
**[Doc]**
23+
```
24+
25+
</details>

0 commit comments

Comments
 (0)