Skip to content

Commit

Permalink
chore: added templates etc to enable contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
taeh98 committed Oct 7, 2023
1 parent bd1d288 commit ae45dd0
Show file tree
Hide file tree
Showing 5 changed files with 559 additions and 0 deletions.
174 changes: 174 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
---
name: "🐛 Bug Report"
about: Report a bug in the library.
title: 'Bug: '
labels: [ 'bug report' ]
---

<!--
Thank you for reporting an issue with this library!
Please fill out all the information below about the bug you've found.
Doing so helps us to fix it ASAP 😃
-->

## ✅ Checklist

- [ ] I have searched
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
and am satisfied that this bug report is not a duplicate
- [ ] I have checked that my bug is present
in [the latest version of this library](https://www.npmjs.com/package/react-native-dropdown-picker)
- [ ] I have
searched [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
and [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs)
and am satisfied that this is indeed a bug rather than simply something I
don't know how to do (if so, make a question/help issue instead)
- [ ] My bug comes from this library and not others, e.g. React Native or
another dependency in my project
- [ ] I understand that each bug should be submitted in its own issue.
Therefore, this issue will contain only one bug, and I will submit any
different bugs in their own, separate issues

## 🤔 Summary

<!--
Please give a brief overview of what this bug is, what it does, and when it appears.
-->

## ⚠️ The problem

### Desired (expected, correct) behaviour

<!--
Please describe how this library should behave and act.
This will be the proper behaviour that should be seen, but isn't because of the bug.
-->

### Actual (unexpected, incorrect) behaviour

<!--
Please describe how this library actually does act.
This will be the undesired behaviour present because of the bug.
-->

### Screenshots/screen recording

<!--
If possible, please include screenshots and/or screen recordings showing the bug.
A picture speaks a thousand words.
-->

### Conditions

<!--
Please describe the circumstances/conditions when you do and don't see this bug.
-->

### Code

<!--
Please copy and paste the relevant code in your project from which this bug arises.
-->

### Log/error output

<!--
If your bug produced terminal output showing any errors or logs, please copy and paste it here.
-->

## 💻 Environment

### react-native-dropdown-picker version

<!--
Please add the version of this library you were using when you saw this bug.
-->

### Node and npm versions

<!--
Please add the versions of Node and npm you were using when you saw this bug.
-->

### React, React Native, and Expo versions

<!--
Please add the versions of React, React Native, and Expo (if applicable) you were using when you saw this bug.
-->

### Package.json contents

<!--
Please copy and paste the contents of your package.json file here.
-->

### Platform/s

<!--
Please include the platform/s on which you've seen this bug.
E.g. iPhone 15 running iOS 17.0.2
-->

### JavaScript or TypeScript

<!--
Is your project where you found the bug written in JavaScript or TypeScript?
-->

### Class component or function component

<!--
Is the component using a DropdownPicker where you saw the bug a class component or a function component?
-->

## 🔁 Reproducing the bug

### Steps To Reproduce

1. Do this
2. Then this
3. ....
4. Bug appears

<!--
Please describe how you can reproduce this bug.
It's important to ensure we can reproduce it.
Without being able to do so, we won't be able to see it.
We must be able to see it to be able to fix it.
-->

### Minimal reproducible example

<!--
Please include a link to a minimal reproducible example of the bug.
This should be the minimum amount of code required to show the bug.
Don't include any code or dependencies not needed for it to be present.
If you found this bug in your project, strip everything else away from it until it is the bare minimum required to demonstrate this bug.
This example might be within:
- an Expo Snack (https://snack.expo.dev)
- a CodeSandbox (https://codesandbox.io)
- a GitHub repo or gist
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve
-->

Link to minimal reproducible example: <example_link_here>

## 🏁 Final details

### Steps to fix

<!--
Have you taken any steps to try to debug or fix this issue?
If you have, what have you learnt while doing so? Did anything work?
What insights and ideas can you give us into how we might fix this bug?
Feel free to edit this library with patch-package (https://github.com/ds300/patch-package).
If you can, see if you can debug or fix the issue and let us know what you find out!
-->

### Additional context/info

<!--
Please include any other information you think is relevant to this bug report.
-->
110 changes: 110 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
name: "🚀 Feature request"
about: Request a new feature to be added to this library.
title: 'Feature request: '
labels: [ 'feature request' ]
---

<!--
Thank you for making a feature request and helping to improve this library!
Please fill out all the information below about your idea.
Doing so helps us to assess its usefulness and feasibility and implement it ASAP 😃
-->

## ✅ Checklist

- [ ] I have searched
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
and am satisfied that this feature request is not a duplicate
- [ ] I have searched
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
and
read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website)
and am satisfied that this feature request is not implemented in the most
recent version of the library
- [ ] I understand that each feature request should be submitted in its own
issue. Therefore, this issue will contain only one feature request, and I will
submit any different feature requests in their own, separate issues

## 🤔 Overview

### Summary

<!--
Please give a brief overview of what this feature would add and why, to whom, and when it would be useful.
-->

### User story

<!--
Please write a user story describing your proposed feature.
See guidance at: https://www.atlassian.com/agile/project-management/user-stories
-->

## 💡 Details

### What

<!--
Please describe what your new feature would do and how it should work.
What would you like to happen?
What would it add to this library?
Please give some examples of how it would be used.
-->

### Who

<!--
Please describe who would find your feature useful.
This will be an end user, e.g. the elderly person who might want a more visible dropdown with which to interact.
This will likely be an agile persona: https://www.wrike.com/agile-guide/faq/what-are-agile-personas
-->

### When

<!--
Please describe the circumstances/conditions when a user would find this feature useful.
Is your proposed feature specific to a platform? If so, which?
-->

### Why

<!--
Please describe why this feature should be implemented.
Why would it be useful?
Please provide any other relevant information on the **use case** you have in mind for this feature.
-->

### How

<!--
Please describe any ideas you have on how this feature could be implemented.
How would you change this library to achieve it?
Considering the architecture of this library and your desired goals for this feature, are there any design choices to think about?
Have you tried implementing any of this functionality with patch-package (https://www.npmjs.com/package/patch-package)?
If so, what did you learn from doing so?
-->

## 🏁 Final details

### Similar/same functionality elsewhere

<!--
Do any other libraries implement functionality the same as or similar to that which you're proposing?
If so, which ones?
Why would it still be useful for us to implement it as well if they already have something the same or similar?
-->

### Possible alternatives

<!--
Have you considered any alternative solutions, approaches, or features?
Please describe them if so.
Why is your proposed feature and solution better than these alternatives?
-->

### Additional context/info

<!--
Please include any other information you think is relevant to this feature request.
-->
Loading

0 comments on commit ae45dd0

Please sign in to comment.