Skip to content

Commit

Permalink
Convert to issue forms (facebook#845)
Browse files Browse the repository at this point in the history
* Initial conversion to issue forms

* Updates to issue forms

* Issue form must have non-empty title

* Replace bug report markdown
  • Loading branch information
chrisglein authored Oct 6, 2021
1 parent c1e4375 commit 3203279
Show file tree
Hide file tree
Showing 6 changed files with 170 additions and 144 deletions.
82 changes: 0 additions & 82 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

86 changes: 86 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
name: 🐛 React Native for macOS Bug Report
description: Report a reproducible bug or regression in React Native for macOS
title: Describe the problem
labels: [bug]
body:
- type: markdown
attributes:
value: |
Your issue will be triaged by the team according to [this process](https://github.com/microsoft/react-native-macos/wiki/Triage-Process).
- type: textarea
validations:
required: true
attributes:
label: Environment
description: |
Please fill in all the relevant fields by running these commands in terminal.
1. `react-native -v`:
3. `npm ls react-native-macos`:
4. `node -v`:
5. `npm -v`:
6. `yarn --version`<!-- (if you use Yarn) -->:
7. `xcodebuild -version`:
value: |
react-native -v:
npm ls react-native-macos:
node -v:
npm -v:
yarn --version:
xcodebuild -version:
render: markdown
- type: textarea
validations:
required: true
attributes:
label: Steps to reproduce the bug
description: |
How would you describe your issue to someone who doesn’t know you or your project?
Try to write a sequence of steps that anybody can repeat to see the issue.
Be specific! If the bug cannot be reproduced, your issue may be closed.
placeholder: |
1. Go to '...'
2. Click on '....'
- type: textarea
attributes:
label: Expected Behavior
description: |
How did you expect your project to behave?
It’s fine if you’re not sure your understanding is correct.
Just write down what you thought would happen.
placeholder: |
Write what you thought would happen
- type: textarea
attributes:
label: Actual Behavior
description: |
Did something go wrong?
Is something broken, or not behaving as you expected?
Describe this section in detail, and attach screenshots if possible.
Don't just say "it doesn't work"!
placeholder: |
Write what happened. Add screenshots!
- type: textarea
attributes:
label: Reproducible Demo
description: |
Please share a project that reproduces the issue.
There are three ways to do it:
- See if the issue is already reproducable within the RNTester app.
If the issue pertains to a particular Component or API, try the corresponding
test page in RNTester.
- Create a new app using https://snack.expo.io/ and try to reproduce the issue in it.
This is useful if you roughly know where the problem is, or can’t share the real code.
- Or, copy your app and remove things until you’re left with the minimal reproducible demo.
This is useful for finding the root cause. You may then optionally create a Snack.
This is a good guide to creating bug demos: https://stackoverflow.com/help/mcve
Once you’re done, copy and paste the link to the Snack or a public GitHub repository below:
placeholder: |
Paste the link to an example project and exact instructions to reproduce the issue.
- type: textarea
attributes:
label: Additional context
description: Write any other additional context that may help in root causing the issue
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: React Native for macOS feature request
description: Suggest a new feature or idea
title: Your feature request
labels: [Proposal, enhancement]
body:
- type: markdown
attributes:
value: |
This is a template for new feature or API proposals for React Native for macOS. Use this to submit new API/component requests or behavior updates that are specific to macOS-only.
- For feature requests to React Native, go [here](https://github.com/react-native-community/discussions-and-proposals) instead.
- For feature requests to React Native for Windows (or) Desktop features in general, go [here](https://github.com/microsoft/react-native-windows/issues/new/choose).
Your issue will be triaged by the team according to [this process](https://github.com/microsoft/react-native-macos/wiki/Triage-Process).
- type: textarea
validations:
required: true
attributes:
label: Summary
description: Brief explanation of the new API or change.
- type: textarea
validations:
required: true
attributes:
label: Motivation
description: |
Why are we doing this? What use cases does it support? What is the expected outcome? Why should this be done for macOS?
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.
- type: textarea
attributes:
label: Basic Example
description: |
If the proposal involves a new or changed API, include a basic code example. Omit this section if it's not applicable.
- type: textarea
attributes:
label: Open Questions
description: |
Please list any open issues that you think still need to be addressed.
These could include areas you think would benefit from community or the react-native-macos team input
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/module_request.md

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/module_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: React Native for macOS Community Module support request
description: Suggest that React Native for macOS support be added to a community module
title: Support react-native-foo
labels: [Extensions, enhancement]
body:
- type: markdown
attributes:
value: |
This Issue template helps us track which modules need to work with React Native for macOS. If you have found a community module that doesn't yet work with React Native for macOS, fill out the Issue fields below!
Your issue will be triaged by the team according to [this process](https://github.com/microsoft/react-native-macos/wiki/Triage-Process).
- type: input
validations:
required: true
attributes:
label: Module
description: Name of the module
placeholder: react-native-foo
- type: input
validations:
required: true
attributes:
label: Module repo url
description: Link to where the module's source code lives
placeholder: https://github.com/react-native-foo/react-native-foo
- type: input
attributes:
label: Target Version
placeholder: "0.63"
- type: input
attributes:
label: Existing issue url
description: If the community module repo already has an issue tracking adding React Native for macOS support, please check this box and link to it.
placeholder: https://github.com/react-native-foo/react-native-foo/issues/1234
- type: input
attributes:
label: Which app/customer is requesting this module?
description: Please describe which app/customer needs this module.
- type: textarea
attributes:
label: In what scenarios will this module be used?
description: Please detail how the app/customer will use the module. Please include screenshots/mockups/wireframes if possible.
- type: textarea
attributes:
label: Essential Features
description: Please enumerate which features of the module are required. For example, you may be using a map module and you only need the 'pinning' functionality and _not_ the turn-by-turn direction functionality.

0 comments on commit 3203279

Please sign in to comment.