[Infra] update issue templates (#3513)
* chore(infra): update issue templates * chore(infra): update pull request template * chore(infra): update bug report template
This commit is contained in:
Krzysztof Moch
GitHub
parent
6a49cba273
commit
ef124c2bdf
64
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
64
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
@ -0,0 +1,64 @@
|
||||
name: Bug report
|
||||
description: Create a report to help us improve
|
||||
title: "[BUG]: "
|
||||
labels: ["bug"]
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: Thanks for taking the time to fill out this bug report!
|
||||
|
||||
- type: dropdown
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version are you using?
|
||||
options:
|
||||
- v6 (Beta)
|
||||
- v5 (Stable)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: platforms
|
||||
attributes:
|
||||
label: What platforms are you having the problem on?
|
||||
multiple: true
|
||||
options:
|
||||
- iOS
|
||||
- Android
|
||||
- Windows
|
||||
- visionOS
|
||||
- Android TV
|
||||
- Apple tvOS
|
||||
|
||||
- type: dropdown
|
||||
id: architecture
|
||||
attributes:
|
||||
label: Architecture
|
||||
description: What architecture are you using?
|
||||
options:
|
||||
- Old architecture
|
||||
- New architecture with interop layer
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Also tell us, what did you expect to happen?
|
||||
placeholder: Tell us what you see!
|
||||
value: "A bug happened!"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Reproduction
|
||||
description: Tell us how can we reproduce this bug
|
||||
placeholder: Reproduction
|
||||
value: "Step to reproduce this bug are: "
|
||||
validations:
|
||||
required: true
|
||||
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,54 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# Bug
|
||||
|
||||
<!--
|
||||
Very important, before opening a ticket:
|
||||
1) Ensure the issue has not been already reported
|
||||
2) lease test using the latest release (including 6.0.0 preRelease) of the library, as maybe the bug has been already fixed.
|
||||
3) please don't use emulator to reproduce issues. if you have strange or sporadic error check if this is not devices specific (understand that this library is just a binding to player).
|
||||
4) ensure you cannot solve the issue by yourself using following guide: https://github.com/react-native-video/react-native-video/blob/master/docs/DEBUGGING.md
|
||||
-->
|
||||
|
||||
## Platform
|
||||
Which player are you experiencing the problem on:
|
||||
* iOS
|
||||
* Android
|
||||
* Windows
|
||||
|
||||
## Environment info
|
||||
|
||||
<!-- This fields are mandatory -->
|
||||
Library version: x.x.x
|
||||
Device:
|
||||
|
||||
## Steps To Reproduce
|
||||
|
||||
<!--
|
||||
Issues without reproduction steps or code are likely to stall.
|
||||
-->
|
||||
|
||||
1.
|
||||
2.
|
||||
...
|
||||
|
||||
## Expected behaviour
|
||||
|
||||
1.
|
||||
2.
|
||||
|
||||
## Reproducible sample code
|
||||
|
||||
<!--
|
||||
Please add to your issue a repro, a fresh codebase with the minimal changes so that the bug can be tested in isolation
|
||||
-->
|
||||
|
||||
## Video sample
|
||||
If possible, include a link to the video that has the problem that can be streamed or downloaded from.
|
||||
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
11
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: GitHub Discussions
|
||||
url: https://github.com/react-native-video/react-native-video/discussions
|
||||
about: Please ask and answer questions here.
|
||||
- name: Slack Channel
|
||||
url: https://join.slack.com/t/video-dev/shared_invite/zt-24kgmctuv-2z0O9J_v6q_rg~x1RujdOA
|
||||
about: You can find us on the VideoDev Slack in the react-native-video channel.
|
||||
- name: TheWidlarzGroup Discord
|
||||
url: https://discord.gg/7Y6eE62hXM
|
||||
about: Feel free to join our Discord server and ask questions there.
|
||||
52
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
52
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
@ -0,0 +1,52 @@
|
||||
name: Feature request
|
||||
description: Suggest an idea for this project
|
||||
title: "[Feature]: "
|
||||
labels: ["feature"]
|
||||
assignees: []
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: Thanks for taking the time to fill out this feature report!
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Tell us your idea and why will concern if we implement it. You can also create a PR 😄
|
||||
placeholder: Tell us your idea!
|
||||
value: "Very cool idea!"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: why-it-is-needed
|
||||
attributes:
|
||||
label: Why it is needed ?
|
||||
description: Tell us your why it is needed!
|
||||
placeholder: Why it is needed ?
|
||||
value: "Because it is cool!"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: possible-implementation
|
||||
attributes:
|
||||
label: Possible implementation
|
||||
description: |
|
||||
Tell us your possible implementation! It really helps if you could describe from a technical POV how this new feature would work, which code it rely on, etc
|
||||
placeholder: How to implement ?
|
||||
value: "Technical POV how to do it"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: code-sample
|
||||
attributes:
|
||||
label: Code sample
|
||||
description: Please show how the new code could work, if doable
|
||||
placeholder: Code sample
|
||||
value: "Code sample"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
|
||||
32
.github/ISSUE_TEMPLATE/feature_request.md
vendored
32
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,32 +0,0 @@
|
||||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
# Feature Request
|
||||
|
||||
<!--
|
||||
This issue should serve for you to present or pitch an idea to the maintainers - but remember that it would be better if you were to submit a PR instead 🤗
|
||||
-->
|
||||
|
||||
## Why it is needed
|
||||
|
||||
<!--
|
||||
Please tell us a bit more of why you want this feature to be added, what's its origin
|
||||
-->
|
||||
|
||||
## Possible implementation
|
||||
|
||||
<!--
|
||||
It really helps if you could describe from a technical POV how this new feature would work, which code it rely on, etc
|
||||
-->
|
||||
|
||||
### Code sample
|
||||
|
||||
<!--
|
||||
Please show how the new code could work, if doable
|
||||
-->
|
||||
21
.github/PULL_REQUEST_TEMPLATE.md
vendored
21
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,20 +1,25 @@
|
||||
<!--
|
||||
Thanks for opening a PR!
|
||||
Since this is a volunteer project and is very active, anything you can do to reduce the amount of time needed to review and merge your PR is appreciated.
|
||||
The following steps will help get your PR merged quickly:
|
||||
|
||||
#### Update the documentation
|
||||
- Update the documentation
|
||||
If you've added new functionality, update the README.md with an entry for your prop or event.
|
||||
The entry should be inserted in alphabetical order.
|
||||
|
||||
#### Update the changelog
|
||||
After you open the PR, update the CHANGELOG.md file with an entry pointing to your PR.
|
||||
|
||||
#### Provide an example of how to test the change
|
||||
- Provide an example of how to test the change
|
||||
If the PR requires special testing setup provide all the relevant instructions and files. This may include a sample video file or URL, configuration, or setup steps.
|
||||
|
||||
#### Focus the PR on only one area
|
||||
Testing multiple features takes longer than isolated changes and if there is a bug in one feature, prevents the other parts of your PR from getting merged until it gets fixed.
|
||||
- Focus the PR on only one area
|
||||
If you're touching multiple different areas that aren't related, break the changes up into multiple PRs.
|
||||
|
||||
#### Describe the changes
|
||||
- Describe the changes
|
||||
Add a note describing what your PR does. If there is a change to the behavior of the code, explain why it needs to be updated.
|
||||
-->
|
||||
## Summary
|
||||
|
||||
### Motivation
|
||||
|
||||
### Changes
|
||||
|
||||
## Test plan
|
||||
Loading…
Reference in New Issue
Block a user