You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Are you on the latest version? You might be using an old version.
12
-
- Have you checked whether or not a similar bug has already been reported?
11
+
> [!TIP]
12
+
> Have you checked for similar issues? There's a possibility the bug you are experiencing has already been reported. Please do a thorough search before creating a new issue.
13
+
14
+
# Description
13
15
- type: textarea
14
16
attributes:
15
-
label: 🪟 What OS build is this issue present?
16
-
description: Windows key + R > winver.exe / Apple Logo (in menu bar) > About This Mac (may not be like this on Ventura)
17
-
placeholder: Windows 11 Insider Beta 22623.1250 / macOS Monterey 12.6.3
18
-
- type: textarea
19
-
attributes:
20
-
label: 🔢 What version are you on?
21
-
- type: textarea
22
-
attributes:
23
-
label: 📄 Description
24
-
description: A clear and concise description of what the bug is.
17
+
label: Description
18
+
description: A clear and concise description of what the issue is.
25
19
validations:
26
20
required: true
21
+
22
+
# Step to reproduce
27
23
- type: textarea
28
24
attributes:
29
-
label: 🪜 Steps To Reproduce
25
+
label: Steps to reproduce
30
26
description: Steps to reproduce the behavior.
31
27
placeholder: |
32
-
1. Go to '....'
33
-
2. Click on '....'
34
-
3. Scroll down to '....'
35
-
4. See the error
28
+
1.
29
+
2.
30
+
3.
36
31
validations:
37
-
required: false
38
-
- type: textarea
32
+
required: true
33
+
34
+
# Version
35
+
- type: input
36
+
id: app_version
39
37
attributes:
40
-
label: 🤔 Expected behavior
41
-
description: A clear and concise description of what you expected to happen.
38
+
label: Version
39
+
description: Which version are you using?
40
+
placeholder: "e.g. 0.14.0-alpha3"
41
+
validations:
42
+
required: true
43
+
44
+
# OS type
42
45
- type: dropdown
43
-
id: platforms-affected
46
+
id: os
44
47
attributes:
45
48
label: Affected platforms
46
-
description: Select all or any platform that you see this issue on. This helps us determine if it's something platform-specific or in the core. If you were only able to test on 1 platform, please check the last option to inform us about that.
49
+
description: |
50
+
Select all or any platform that you see this issue on. This helps us determine if it's something platform-specific or in the core.
47
51
multiple: true
48
52
options:
49
53
- 📱 Android
@@ -58,15 +62,45 @@ body:
58
62
- 🕸️ WebAssembly
59
63
- ❓ Other
60
64
- ☹️ I was unable to test on other platforms
65
+
66
+
# OS Version
67
+
- type: input
68
+
id: os_version
69
+
attributes:
70
+
label: Platform version
71
+
description: Which version of your OS are you using? Press <kbd>Win</kbd> + <kbd>Pause/Break</kbd> and copy or <kbd>🍏</kbd> (in menu bar) and <kbd>About This Mac</kbd>
72
+
placeholder: "e.g. 10.0.22621.1848"
61
73
validations:
62
74
required: true
63
-
- type: textarea
64
-
id: workaround
75
+
76
+
# Note that the user should always upload the report rather than pasting it
77
+
- type: markdown
65
78
attributes:
66
-
label: ⚒️ Did you find any workaround?
67
-
description: Did you find any workaround for this issue? This can unblock other people while waiting for this issue to be resolved or even give us a hint on how to fix this.
79
+
value: |
80
+
> [!IMPORTANT]
81
+
> Please **upload** the log file by clicking "Attach files".
82
+
>
83
+
> Feel free to remove sensitive information such as your usernames or drive names.
84
+
85
+
# Log File
68
86
- type: textarea
69
87
attributes:
70
-
label: 📸 Assets
88
+
label: Log File
71
89
description: |
72
-
A list of assets (errors, screenshots) relevant to the bug.
90
+
Please upload the log file as an attachment
91
+
placeholder: |
92
+
Copy the log from the crash window or upload as an upload it from the log location.
93
+
validations:
94
+
required: true
95
+
96
+
# Separator
97
+
- type: markdown
98
+
attributes:
99
+
value: |
100
+
---
101
+
102
+
# Additional Comments
103
+
- type: textarea
104
+
attributes:
105
+
label: Comments
106
+
description: Additional information, comments or screenshots about the issue.
description: Create a code quality issue to help keep a clean codebase
3
+
title: 'Code Quality: '
4
+
body:
5
+
6
+
# Tip to warn of checking for existing issues
7
+
- type: markdown
8
+
attributes:
9
+
value: |
10
+
> [!TIP]
11
+
> Have you checked for similar code quality issues? There's a possibility your suggestion is already being tracked. Please do a thorough search before creating a new issue.
12
+
13
+
# Issue body
14
+
- type: textarea
15
+
attributes:
16
+
label: Description
17
+
description: A clear and concise description of what the code quality issue is.
18
+
validations:
19
+
required: true
20
+
21
+
# Related code
22
+
- type: textarea
23
+
attributes:
24
+
label: Concerned code
25
+
description: A list of the different files and/or areas of the code concerned by the issue.
26
+
validations:
27
+
required: true
28
+
29
+
# Gains
30
+
- type: textarea
31
+
attributes:
32
+
label: Gains
33
+
description: What would fixing this code quality issue bring to the source code?
34
+
value: |
35
+
- eg. A better readability.
36
+
- eg. Uncoupling concepts X and Y.
37
+
- eg. Clarifying the responsibility of class C.
38
+
validations:
39
+
required: true
40
+
41
+
# Requirements
42
+
- type: textarea
43
+
attributes:
44
+
label: Requirements
45
+
description: Describe all the requirements to solve the code quality issue.
46
+
value: |
47
+
- eg. Using a specific design pattern.
48
+
- eg. Separating Interface I into three new interfaces I1, I2 and I3.
49
+
- eg. Regrouping the duplicated process into a new helper.
50
+
51
+
# Separator
52
+
- type: markdown
53
+
attributes:
54
+
value: |
55
+
---
56
+
57
+
# Additional comments
58
+
- type: textarea
59
+
attributes:
60
+
label: Comments
61
+
description: Additional information, comments or screenshots about the code quality issue.
description: Request a new feature to make things better!
3
-
labels: [feature request]
4
-
title: "Feature: "
5
-
type: Feature
2
+
description: This project thrives from differentiation from competing apps. Suggest an idea today!
3
+
title: 'Feature: '
6
4
body:
5
+
6
+
# Tip to warn of checking for existing issues
7
7
- type: markdown
8
8
attributes:
9
9
value: |
10
-
##### ⏱️ Before you start...
11
-
- Have you checked whether or not a similar feature request has already been reported?
10
+
> [!TIP]
11
+
> Have you checked for similar feature requests? There's a possibility your suggestion is already being tracked. Please do a thorough search before creating a new issue.
12
+
13
+
# Description
12
14
- type: textarea
13
15
attributes:
14
-
label: 📄 Description
15
-
description: A clear and concise description of what your idea is. Include things like possible use cases, drawbacks, etc.
16
+
label: What feature or improvement do you think would benefit the app?
17
+
description: Please include your use case
16
18
validations:
17
19
required: true
20
+
21
+
# Tooltip about requirements
22
+
- type: markdown
23
+
attributes:
24
+
value: |
25
+
Please include a list of changes required to make this improvement. A good rule of thumb is to start your proposal with no more than 7 high-level requirements.
26
+
27
+
# Requirements
18
28
- type: textarea
19
29
attributes:
20
-
label: 🗃️ Alternative solutions
21
-
description: Describe more ways this idea could be implemented.
30
+
label: Requirements
31
+
description: Describe all the requirements to make your idea happen.
32
+
value: |
33
+
#### 📋 High Priority
34
+
- [ ] Something
35
+
- [ ] Another thing
36
+
- [ ] https://github.com/link/to/an/issue
37
+
38
+
#### 📋 Nice to have
39
+
- [ ] Something
40
+
- [ ] Another thing
41
+
- [ ] https://github.com/link/to/an/issue
22
42
validations:
23
-
required: false
43
+
required: true
44
+
45
+
# Version
46
+
- type: input
47
+
id: app_version
48
+
attributes:
49
+
label: Version
50
+
description: Which version are you using?
51
+
placeholder: "e.g. 0.14.0-alpha3"
52
+
53
+
# Separator
54
+
- type: markdown
55
+
attributes:
56
+
value: |
57
+
---
58
+
24
59
- type: textarea
25
60
id: api-changes
26
61
attributes:
27
-
label: ⚡ API Changes
62
+
label: API Changes
28
63
description: Include a list of all API changes, additions, subtractions as would be required by your proposal. These APIs should be considered placeholders, so the naming is not as important as getting the concepts correct. If possible you should include some example (pseudo-)code of usage of your new API.
29
64
placeholder: |
30
65
```csharp
@@ -35,36 +70,24 @@ body:
35
70
The MakeShiny API works even if the button is already visible.
36
71
validations:
37
72
required: false
73
+
38
74
- type: textarea
39
75
id: use-case
40
76
attributes:
41
-
label: 👥 Intended Use-Case
77
+
label: Intended Use-Case
42
78
description: Provide a detailed example of where your proposal would be used and for what purpose. Focus on _why_ you want this feature instead of _what_ the feature does.
43
79
placeholder: I have a situation where I would really want a shiny button to make it stand out from the rest of the plain and boring buttons.
44
80
validations:
45
81
required: false
46
-
- type: textarea
82
+
83
+
# Separator
84
+
- type: markdown
47
85
attributes:
48
-
label: ✅ Tasks
49
-
description: Give an overview of all the specific things you would like to be changed or implemented.
50
86
value: |
51
-
```[tasklist]
52
-
### High Priority
53
-
- [ ] Something
54
-
- [ ] Another thing
55
-
- [ ] https://github.com/link/to/an/issue
56
-
```
57
-
```[tasklist]
58
-
### Nice to have
59
-
- [ ] Something
60
-
- [ ] Another thing
61
-
- [ ] https://github.com/link/to/an/issue
62
-
```
63
-
validations:
64
-
required: false
87
+
---
88
+
89
+
# Additional comments
65
90
- type: textarea
66
91
attributes:
67
-
label: 📸 Assets
68
-
description: A list of assets (screenshots, mockups) relevant to this feature request.
69
-
validations:
70
-
required: false
92
+
label: Comments
93
+
description: Additional information, comments or screenshots about the feature request.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/spec.yml
+5-7Lines changed: 5 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,7 @@
1
1
name: Spec
2
2
description: An official specification for enhancements.
3
-
labels: ["enhancement"]
4
3
assignees: []
5
4
title: "Spec: "
6
-
type: Spec
7
5
body:
8
6
- type: markdown
9
7
attributes:
@@ -14,14 +12,14 @@ body:
14
12
- type: textarea
15
13
id: description
16
14
attributes:
17
-
label: 📄 Description
15
+
label: Description
18
16
description: Provide a concise description of the feature and the motivation for adding it. This can be a modified version from the feature request prior to this.
19
17
validations:
20
18
required: true
21
19
- type: textarea
22
20
id: api-changes
23
21
attributes:
24
-
label: ⚡ API Changes
22
+
label: API Changes
25
23
description: Include a complete list of all API changes, additions, subtractions as would be required by your proposal.
26
24
value: |
27
25
## `[ class ]`
@@ -34,7 +32,7 @@ body:
34
32
- type: textarea
35
33
id: usage-scenarios
36
34
attributes:
37
-
label: 👥 Usage scenarios
35
+
label: Usage scenarios
38
36
description: Give us a couple of scenarios that demonstrate how developers would consume the above APIs.
39
37
placeholder: |
40
38
# C# Example
@@ -53,7 +51,7 @@ body:
53
51
- type: textarea
54
52
id: backwards-compatibility
55
53
attributes:
56
-
label: 🔙 Backward Compatibility
54
+
label: Backward Compatibility
57
55
description: Please describe here anything in terms of backwards compatibility. Will there be breaking changes? Do we need to update dependencies to support this? What are the minimum supported API/OS levels? And lastly, are there any platforms that can't support this and why?
58
56
placeholder: |
59
57
Minimum API levels?
@@ -64,7 +62,7 @@ body:
64
62
- type: dropdown
65
63
id: difficulty
66
64
attributes:
67
-
label: 🤔 Difficulty
65
+
label: Difficulty
68
66
description: What do you feel will be the difficulty of this change all things considering? No exact science, just your gut feeling.
0 commit comments