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
## 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_
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/bug-report.yaml
+43-29Lines changed: 43 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,27 @@ name: Bug report
2
2
description: File a bug report
3
3
title: Describe the problem
4
4
labels: [bug]
5
+
type: 'Bug'
5
6
body:
6
7
- type: markdown
7
8
attributes:
8
9
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
+
9
16
Your issue will be triaged by the RNW team according to [this process](https://github.com/microsoft/react-native-windows/wiki/Triage-Process).
10
17
- type: textarea
11
18
validations:
12
19
required: true
13
20
attributes:
14
21
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.
16
26
id: description
17
27
- type: textarea
18
28
validations:
@@ -35,54 +45,63 @@ body:
35
45
attributes:
36
46
label: CLI version
37
47
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"
40
50
id: cli
41
51
- type: textarea
42
52
validations:
43
53
required: true
44
54
attributes:
45
55
label: Environment
46
56
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.
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.
55
68
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)"
56
84
- type: dropdown
57
85
attributes:
58
86
label: Target Platform Version
59
-
description: What SDK version are you building for?
87
+
description: What Windows SDK version are you building for?
60
88
options:
61
-
- "10.0.15063"
62
-
- "10.0.16299"
89
+
- "<= 10.0.17763"
90
+
- "10.0.17763"
91
+
- "10.0.18362"
63
92
- "10.0.19041"
64
93
- "10.0.22000"
65
-
- "10.0.22321"
66
94
- "10.0.22621"
95
+
- "10.0.26100"
96
+
- ">= 10.0.26100"
67
97
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
78
98
- type: dropdown
79
99
attributes:
80
100
label: Visual Studio Version
81
101
description: Which version of Visual Studio are you using?
82
102
options:
83
-
- "Visual Studio 2017"
84
-
- "Visual Studio 2019"
85
103
- "Visual Studio 2022"
104
+
- "Visual Studio 2022 Preview"
86
105
id: vs
87
106
- type: dropdown
88
107
attributes:
@@ -94,18 +113,13 @@ body:
94
113
- "Release"
95
114
- "ReleaseBundle"
96
115
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
103
116
- type: textarea
104
117
attributes:
105
118
label: Snack, code example, screenshot, or link to a repository
106
119
description: |
107
120
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
+
108
122
You may provide a screenshot of the application if you think it is relevant to your bug report.
123
+
109
124
[Here are some tips for providing a minimal example](https://stackoverflow.com/help/mcve).
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/feature-request.yaml
+13-4Lines changed: 13 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,16 @@ name: Feature request
2
2
description: Suggest a new feature or idea
3
3
title: Your feature request
4
4
labels: [enhancement]
5
+
type: 'Task'
5
6
body:
6
7
- type: markdown
7
8
attributes:
8
9
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.
10
15
11
16
Read more about React Native for Windows proposal process [here](https://github.com/microsoft/react-native-windows/tree/main/vnext/proposals).
12
17
@@ -24,7 +29,10 @@ body:
24
29
label: Motivation
25
30
description: |
26
31
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.
28
36
- type: textarea
29
37
attributes:
30
38
label: Basic Example
@@ -34,5 +42,6 @@ body:
34
42
attributes:
35
43
label: Open Questions
36
44
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.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/integration-follow-up.yaml
+9-6Lines changed: 9 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,42 +1,45 @@
1
1
name: Integration Follow-up Report
2
2
description: File an integration follow-up issue
3
3
labels: [Integration Follow-up]
4
+
type: 'Task'
4
5
body:
5
6
- type: markdown
6
7
attributes:
7
8
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
+
8
11
Your issue will be triaged by the RNW team according to [this process](https://github.com/microsoft/react-native-windows/wiki/Triage-Process).
9
12
- type: textarea
10
13
validations:
11
14
required: true
12
15
attributes:
13
16
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.
15
18
id: description
16
-
- type: textarea
19
+
- type: input
17
20
validations:
18
21
required: true
19
22
attributes:
20
-
label: Link to the integration where the error originated
23
+
label: Link to the integration PR where the error originated
21
24
id: integration
22
25
- type: textarea
23
26
validations:
24
27
required: true
25
28
attributes:
26
-
label: Link to commit
29
+
label: Link to `react-native` commit
27
30
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.
28
31
id: commit
29
32
- type: textarea
30
33
attributes:
31
34
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.
33
36
placeholder: |
34
37
1.
35
38
2.
36
39
id: files
37
40
- type: textarea
38
41
attributes:
39
-
label: Upstream PR
42
+
label: Upstream PR in `react-native`
40
43
description: If an upstream PR has already been made, please link it and add the date the fork can be removed.
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?
0 commit comments