Skip to content

Commit 84110d9

Browse files
committed
Add feature proposal template
1 parent 8b3cb7c commit 84110d9

File tree

2 files changed

+80
-3
lines changed

2 files changed

+80
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,6 @@ body:
9494
label: Help us help you
9595
description: Would you like to contribute a solution to this issue?
9696
options:
97-
- Yes, I'd like to be assigned to work on this item.
98-
- Yes, but only if others can assist.
99-
- No, just wanted to report this.
97+
- Yes, I'd like to be assigned to work on this item
98+
- Yes, but only if others can assist
99+
- No, just wanted to report this
Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Feature request
2+
description: Propose a new feature
3+
labels: "feature request :mailbox_with_mail:"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Before you begin
9+
10+
🚨 **Please do not skip instructions** 🚨
11+
12+
This info is essential to properly review your proposal. Proposals with missing information may be closed without investigation. Please make sure to look for existing proposals about the same thing before opening a new one. If you're uncertain about the problem you're trying to solve, [find or start a discussion](https://github.com/CommunityToolkit/dotnet/discussions), where you can get insight from the community regarding your proposal.
13+
- type: textarea
14+
id: description
15+
validations:
16+
required: true
17+
attributes:
18+
label: Overview
19+
description: A clear and concise overview of the problem this proposal would solve.
20+
- type: textarea
21+
id: api-breakdown
22+
validations:
23+
required: true
24+
attributes:
25+
label: API breakdown
26+
description: A complete API breakdown of the new proposed feature or change.
27+
placeholder: |
28+
```csharp
29+
namespace CommunityToolkit.SomePackage;
30+
31+
public class MyProposedClass
32+
{
33+
public void MyProposedApi();
34+
// Other APIs and types as needed...
35+
}
36+
```
37+
- type: textarea
38+
id: usage-example
39+
validations:
40+
required: true
41+
attributes:
42+
label: Usage example
43+
description: An example of of the new API would be used in practice.
44+
- type: dropdown
45+
id: breaking-change
46+
validations:
47+
required: true
48+
attributes:
49+
label: Breaking change?
50+
description: Is the proposed change going to break existing APIs?
51+
options:
52+
- Yes
53+
- No
54+
- Not sure
55+
- type: textarea
56+
id: alternatives
57+
validations:
58+
required: true
59+
attributes:
60+
label: Alternatives
61+
description: An example of alternative approaches that can currently be used, if any.
62+
- type: textarea
63+
id: additional-context
64+
attributes:
65+
label: Additional context
66+
description: Add any other context about the problem here.
67+
- type: dropdown
68+
id: contribution
69+
validations:
70+
required: true
71+
attributes:
72+
label: Help us help you
73+
description: Would you like to contribute a solution to this issue?
74+
options:
75+
- Yes, I'd like to be assigned to work on this item
76+
- Yes, but only if others can assist
77+
- No, just wanted to propose this

0 commit comments

Comments
 (0)