mirror of
https://github.com/zoriya/react-native-svg.git
synced 2025-12-06 07:06:11 +00:00
chore: improve github templates
This commit is contained in:
5
.github/ISSUE_TEMPLATE.md
vendored
Normal file
5
.github/ISSUE_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
# No Template
|
||||
|
||||
👉 Please follow one of the issue templates provided by the repo - if you are seeing this message, it means you haven't.
|
||||
|
||||
If you don't follow the issue template, we may immediately close it.
|
||||
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
54
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
name: '🐛 Bug Report'
|
||||
about: Report a reproducible bug or regression in this library.
|
||||
---
|
||||
|
||||
# Bug
|
||||
|
||||
Please provide a clear and concise description of what the bug is.
|
||||
Include screenshots if needed.
|
||||
Please test using the latest release of the library, as maybe said bug has been already fixed.
|
||||
If the library has multiple install methods, describe installation method (e.g., pod, not pod, with jetifier etc)
|
||||
|
||||
|
||||
## Environment info
|
||||
|
||||
Run `react-native info` in your terminal and copy the results here. Also, include the *precise* version number of this library that you are using in the project
|
||||
|
||||
|
||||
React native info output:
|
||||
|
||||
```bash
|
||||
// paste it here
|
||||
```
|
||||
|
||||
Library version: x.x.x
|
||||
|
||||
## Steps To Reproduce
|
||||
|
||||
Issues without reproduction steps or code are likely to stall.
|
||||
|
||||
1. git clone https://github.com/user/rnsvg-bug-repro
|
||||
2. cd rnsvg-bug-repro
|
||||
3. yarn
|
||||
4. yarn ios
|
||||
5. yarn android
|
||||
6. ...
|
||||
|
||||
Describe what you expected to happen:
|
||||
|
||||
1.
|
||||
2.
|
||||
|
||||
## Short, Self Contained, Correct (Compilable), Example
|
||||
|
||||
If you are having a problem with some code and seeking help, preparing a Short, Self Contained, Correct Example (SSCCE) is very useful. But what is an SSCCE?
|
||||
|
||||
It is all in the name, really. Take a look at each part. The version prepared for others to see should be:
|
||||
|
||||
Short (Small) - Minimise bandwidth for the example, do not bore the audience.
|
||||
Self Contained - Ensure everything is included, ready to go.
|
||||
Correct - Copy, paste, (compile,) see is the aim.
|
||||
Example - Displays the problem we are trying to solve.
|
||||
|
||||
http://www.sscce.org/
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: '💡 Feature Request'
|
||||
about: Submit your idea for a change in the codebase.
|
||||
---
|
||||
|
||||
# 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
|
||||
12
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
12
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
---
|
||||
name: '🤔 Questions and Help'
|
||||
about: Use this if there is something not clear about the code or its docs.
|
||||
---
|
||||
|
||||
# Question
|
||||
|
||||
Before submitting it, please ensure that this was not already asked in another issue, or on StackOverflow. Ideally, you should always refer to StackOverflow first.
|
||||
|
||||
This issue should serve for you to ask a question about the library to the maintainers and other fellow developers - remember that even if the issue gets closed, the conversation can move forward 🤗
|
||||
Also, ideally this issue should culminate in a PR to the documentation for this library so that future developers will have that doubt cleared.
|
||||
|
||||
34
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
34
.github/PULL_REQUEST_TEMPLATE.md
vendored
Normal file
@@ -0,0 +1,34 @@
|
||||
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect -->
|
||||
|
||||
# Summary
|
||||
|
||||
Explain the **motivation** for making this change: here are some points to help you:
|
||||
|
||||
* What issues does the pull request solve? Please tag them so that they will get automatically closed once the PR is merged
|
||||
* What is the feature? (if applicable)
|
||||
* How did you implement the solution?
|
||||
* What areas of the library does it impact?
|
||||
|
||||
## Test Plan
|
||||
|
||||
Demonstrate the code is solid. Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI.
|
||||
|
||||
### What's required for testing (prerequisites)?
|
||||
|
||||
### What are the steps to reproduce (after prerequisites)?
|
||||
|
||||
## Compatibility
|
||||
|
||||
| OS | Implemented |
|
||||
| ------- | :---------: |
|
||||
| iOS | ✅❌ |
|
||||
| Android | ✅❌ |
|
||||
|
||||
## Checklist
|
||||
|
||||
<!-- Check completed item, when applicable, via: [X] -->
|
||||
|
||||
- [ ] I have tested this on a device and a simulator
|
||||
- [ ] I added documentation in `README.md`
|
||||
- [ ] I updated the typed files (typescript)
|
||||
- [ ] I added a test for the API in the `__tests__` folder
|
||||
41
.github/stale.yml
vendored
Normal file
41
.github/stale.yml
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
# Configuration for probot-stale based on: https://github.com/facebook/react-native/blob/master/.github/stale.yml
|
||||
|
||||
# Number of days of inactivity before an Issue or Pull Request becomes stale
|
||||
daysUntilStale: 60
|
||||
|
||||
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
|
||||
daysUntilClose: 7
|
||||
|
||||
# Issues or Pull Requests.
|
||||
exemptLabels:
|
||||
- pinned
|
||||
- security
|
||||
- discussion
|
||||
|
||||
# Set to true to ignore issues in a project (defaults to false)
|
||||
exemptProjects: false
|
||||
|
||||
# Set to true to ignore issues in a milestone (defaults to false)
|
||||
exemptMilestones: false
|
||||
|
||||
# Set to true to ignore issues with an assignee (defaults to false)
|
||||
exemptAssignees: false
|
||||
|
||||
# Label to use when marking as stale
|
||||
staleLabel: stale
|
||||
|
||||
# Comment to post when marking as stale. Set to `false` to disable
|
||||
markComment: >
|
||||
This issue has been automatically marked as stale because it has not had
|
||||
recent activity. It will be closed if no further activity occurs. Thank you
|
||||
for your contributions. You may also mark this issue as a "discussion" and I
|
||||
will leave this open.
|
||||
# Comment to post when closing a stale Issue or Pull Request.
|
||||
closeComment: >
|
||||
Closing this issue after a prolonged period of inactivity. Fell free to reopen
|
||||
this issue, if this still affecting you.
|
||||
# Limit the number of actions per hour, from 1-30. Default is 30
|
||||
limitPerRun: 30
|
||||
|
||||
# Limit to only `issues` or `pulls`
|
||||
only: issues
|
||||
Reference in New Issue
Block a user