Skip to content

Commit 5fc1c31

Browse files
authored
Update GitHub issue templates (#14745)
## Description This PR cleans up our existing GitHub issue templates to remove prompts for unnecessary information while also making some prompts required and harder to ignore, to reduce the amount of time we send back issues for more information. This PR also adds a new "Missing API" template to capture when expected React Native APIs aren't present on Windows. ### Type of Change - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) ### Why See above. ### What See above. ## Screenshots N/A ## Testing N/A ## Changelog Should this change be included in the release notes: _no_
1 parent 45fccf9 commit 5fc1c31

File tree

4 files changed

+123
-39
lines changed

4 files changed

+123
-39
lines changed

.github/ISSUE_TEMPLATE/bug-report.yaml

Lines changed: 43 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,27 @@ name: Bug report
22
description: File a bug report
33
title: Describe the problem
44
labels: [bug]
5+
type: 'Bug'
56
body:
67
- type: markdown
78
attributes:
89
value: |
10+
This form is for reporting bugs found in React Native for Windows.
11+
12+
If the issue is that an existing React Native API is simply missing in React Native for Windows, please use the [this form](https://github.com/microsoft/react-native-windows/issues/new?template=missing-api.yaml) instead.
13+
14+
If you just have a question, please post on [Discussions](https://github.com/microsoft/react-native-windows/discussions) instead.
15+
916
Your issue will be triaged by the RNW team according to [this process](https://github.com/microsoft/react-native-windows/wiki/Triage-Process).
1017
- type: textarea
1118
validations:
1219
required: true
1320
attributes:
1421
label: Problem Description
15-
description: Please enter a description of the issue. If you just have a question, please post on [Discussions](https://github.com/microsoft/react-native-windows/discussions).
22+
description: |
23+
Please enter a description of the issue and any output and/or error logging.
24+
25+
If you're seeing a failure when using a RNW CLI command (i.e. `run-windows`, `autolink-windows`, `codegen-windows`) please try again with `--logging` and provide that output.
1626
id: description
1727
- type: textarea
1828
validations:
@@ -35,54 +45,63 @@ body:
3545
attributes:
3646
label: CLI version
3747
description: |
38-
Run the command `npx @react-native-community/cli --version` in your terminal and copy the results here
39-
value: "npx @react-native-community/cli -v"
48+
Run the command `npx @react-native-community/cli -v` in your terminal and copy the result here.
49+
placeholder: "npx @react-native-community/cli -v"
4050
id: cli
4151
- type: textarea
4252
validations:
4353
required: true
4454
attributes:
4555
label: Environment
4656
description: |
47-
Run the command `npx @react-native-community/cli info` in your terminal and copy the results here
48-
value: "npx @react-native-community/cli info"
57+
Run the command `npx @react-native-community/cli info` in your terminal and copy the result here.
58+
placeholder: "npx @react-native-community/cli info"
4959
render: markdown
5060
id: env
5161
- type: textarea
5262
attributes:
5363
label: Community Modules
54-
description: Describe what you community modules you have added to your project. Not sure? Look at your app's `package.json` and share what's in the "dependencies" section.
64+
description: |
65+
Describe what you community modules you have added to your project.
66+
67+
Not sure? Look at your app's `package.json` and share what's in the "dependencies" section.
5568
id: modules
69+
- type: dropdown
70+
validations:
71+
required: true
72+
attributes:
73+
label: Target React Native Architecture
74+
description: |
75+
Which React Native architecture(s) are you using?
76+
77+
Not sure? Which template did you use when creating your project? For RNW <= 0.79.0, the default for new app projects is "Old Architecture".
78+
79+
See [New vs. Old Architecture](https://microsoft.github.io/react-native-windows/docs/new-architecture) for more details.
80+
multiple: true
81+
options:
82+
- "New Architecture (WinAppSDK)"
83+
- "Old Architecture (UWP)"
5684
- type: dropdown
5785
attributes:
5886
label: Target Platform Version
59-
description: What SDK version are you building for?
87+
description: What Windows SDK version are you building for?
6088
options:
61-
- "10.0.15063"
62-
- "10.0.16299"
89+
- "<= 10.0.17763"
90+
- "10.0.17763"
91+
- "10.0.18362"
6392
- "10.0.19041"
6493
- "10.0.22000"
65-
- "10.0.22321"
6694
- "10.0.22621"
95+
- "10.0.26100"
96+
- ">= 10.0.26100"
6797
id: sdk
68-
- type: dropdown
69-
attributes:
70-
label: Target Device(s)
71-
description: What device(s) are you targeting?
72-
multiple: true
73-
options:
74-
- "Desktop"
75-
- "Xbox"
76-
- "HoloLens"
77-
id: device
7898
- type: dropdown
7999
attributes:
80100
label: Visual Studio Version
81101
description: Which version of Visual Studio are you using?
82102
options:
83-
- "Visual Studio 2017"
84-
- "Visual Studio 2019"
85103
- "Visual Studio 2022"
104+
- "Visual Studio 2022 Preview"
86105
id: vs
87106
- type: dropdown
88107
attributes:
@@ -94,18 +113,13 @@ body:
94113
- "Release"
95114
- "ReleaseBundle"
96115
id: config
97-
- type: markdown
98-
attributes:
99-
value: |
100-
**Troubleshooting**
101-
If you see build failure on `npx @react-native-community/cli run-windows`, please try again with `npx @react-native-community/cli run-windows --logging` and provide the output.
102-
id: troubleshoot
103116
- type: textarea
104117
attributes:
105118
label: Snack, code example, screenshot, or link to a repository
106119
description: |
107120
Please provide a [Snack](https://snack.expo.io/), a link to a repository on GitHub, or provide a minimal code example that reproduces the problem.
121+
108122
You may provide a screenshot of the application if you think it is relevant to your bug report.
123+
109124
[Here are some tips for providing a minimal example](https://stackoverflow.com/help/mcve).
110125
id: code
111-

.github/ISSUE_TEMPLATE/feature-request.yaml

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,16 @@ name: Feature request
22
description: Suggest a new feature or idea
33
title: Your feature request
44
labels: [enhancement]
5+
type: 'Task'
56
body:
67
- type: markdown
78
attributes:
89
value: |
9-
This is a template for new feature or API proposals for React Native for Windows. Use this to submit new API/component requests or behavior updates that are specific to Windows. For feature requests to React Native, go [here](https://github.com/react-native-community/discussions-and-proposals) instead.
10+
This form is for new feature or API (modules or components, methods or properties, etc.) proposals for React Native for Windows. Use this to submit new API requests or behavior updates that are *specific* to Windows.
11+
12+
If your request is for is an existing React Native API that is simply missing in React Native for Windows, please use the [this form](https://github.com/microsoft/react-native-windows/issues/new?template=missing-api.yaml) instead.
13+
14+
For feature requests to React Native, go [here](https://github.com/react-native-community/discussions-and-proposals) instead.
1015
1116
Read more about React Native for Windows proposal process [here](https://github.com/microsoft/react-native-windows/tree/main/vnext/proposals).
1217
@@ -24,7 +29,10 @@ body:
2429
label: Motivation
2530
description: |
2631
Why are we doing this? What use cases does it support? What is the expected outcome? Why should this be done for Windows?
27-
Please focus on explaining the motivation so that if this proposal is not accepted, the motivation could be used to develop alternative solutions. In other words, enumerate the constraints you are trying to solve without coupling them too closely to the solution you have in mind.
32+
33+
Please focus on explaining the motivation so that if this proposal is not accepted, the motivation could be used to develop alternative solutions.
34+
35+
In other words, enumerate the constraints you are trying to solve without coupling them too closely to the solution you have in mind.
2836
- type: textarea
2937
attributes:
3038
label: Basic Example
@@ -34,5 +42,6 @@ body:
3442
attributes:
3543
label: Open Questions
3644
description: |
37-
Please list any open issues that you think still need to be addressed.
38-
These could include areas you think would benefit from community or the react-native-windows team input
45+
Please list any open questions or issues that you think still need to be addressed before this suggestion can be implemented.
46+
47+
These could include areas you think would benefit from the community or the RNW team's input.

.github/ISSUE_TEMPLATE/integration-follow-up.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,45 @@
11
name: Integration Follow-up Report
22
description: File an integration follow-up issue
33
labels: [Integration Follow-up]
4+
type: 'Task'
45
body:
56
- type: markdown
67
attributes:
78
value: |
9+
This form is for reporting issues in React Native for Windows arising from integrating upstream `react-native` code, where the issues were worked-around or fixed locally to unblock the integration, but will need some follow-up afterward.
10+
811
Your issue will be triaged by the RNW team according to [this process](https://github.com/microsoft/react-native-windows/wiki/Triage-Process).
912
- type: textarea
1013
validations:
1114
required: true
1215
attributes:
1316
label: Problem Description
14-
description: This form is for reporting errors arising from Meta integrations. Please provide a detailed description of the issue and any relevant information that may assist in debugging.
17+
description: Please provide a detailed description of the issue and any relevant information that may assist in debugging.
1518
id: description
16-
- type: textarea
19+
- type: input
1720
validations:
1821
required: true
1922
attributes:
20-
label: Link to the integration where the error originated
23+
label: Link to the integration PR where the error originated
2124
id: integration
2225
- type: textarea
2326
validations:
2427
required: true
2528
attributes:
26-
label: Link to commit
29+
label: Link to `react-native` commit
2730
description: Please link the specific commit from upstream that introduced the issue. If the exact commit is unknown, provide the range of commits brought in from the integration.
2831
id: commit
2932
- type: textarea
3033
attributes:
3134
label: Forked files
32-
description: If any files were forked from upstream, list them below and ensure that any Windows-specific changes in those files are enclosed in [Windows] comments."
35+
description: If any files were forked from upstream, list them below and ensure that any Windows-specific changes in those files are enclosed in [Windows] comments.
3336
placeholder: |
3437
1.
3538
2.
3639
id: files
3740
- type: textarea
3841
attributes:
39-
label: Upstream PR
42+
label: Upstream PR in `react-native`
4043
description: If an upstream PR has already been made, please link it and add the date the fork can be removed.
4144
id: upstream
4245
- type: dropdown
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Missing React Native API on Windows
2+
description: Report that a React Native API is missing on Windows
3+
title: Implement <missing API name> for <architecture>
4+
labels: ['enhancement', 'API: Completion']
5+
type: 'Task'
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
This form is to report APIs (methods or properties, etc.) which exist in React Native for iOS/Android but are missing or otherwise not implemented in React Native for Windows.
11+
12+
If the API does not exist in React Native, please use the [this form](https://github.com/microsoft/react-native-windows/issues/new?template=feature-request.yaml) instead.
13+
14+
Your issue will be triaged by the RNW team according to [this process](https://github.com/microsoft/react-native-windows/wiki/Triage-Process).
15+
- type: input
16+
validations:
17+
required: true
18+
attributes:
19+
label: APInName
20+
description: What is the name of the missing API (including module or component name)?
21+
placeholder: API Name
22+
- type: dropdown
23+
validations:
24+
required: true
25+
attributes:
26+
label: API Type
27+
description: What is the type of the missing API?
28+
options:
29+
- "Component Method"
30+
- "Component Property"
31+
- "Module Method"
32+
- "Module Property"
33+
- "Other"
34+
id: type
35+
- type: input
36+
validations:
37+
required: true
38+
attributes:
39+
label: React Native Docs URL
40+
description: Where is the API documented on reactnative.dev?
41+
placeholder: https://reactnative.dev/docs/components-and-apis
42+
id: url
43+
- type: dropdown
44+
validations:
45+
required: true
46+
attributes:
47+
label: Supported Architecture
48+
description: For which React Native architecture is the API supported?
49+
options:
50+
- "Both Architectures"
51+
- "New Only"
52+
- "Old Only"
53+
id: architecture
54+
- type: textarea
55+
attributes:
56+
label: Other Details
57+
description: Please add any other details that may be relevant to implementing this API.
58+
id: details

0 commit comments

Comments
 (0)