Skip to content

Commit 6a462a9

Browse files
taeh98taeh98
committed
chore: added issue templates to enable contributions
1 parent 09c6364 commit 6a462a9

File tree

4 files changed

+293
-0
lines changed

4 files changed

+293
-0
lines changed

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
name: "🐛 Bug Report"
3+
about: Report a bug in the library.
4+
title: 'Bug: '
5+
labels: [ 'bug report' ]
6+
---
7+
8+
<!--
9+
Thank you for reporting an issue with this library!
10+
Please fill out all the information below about the bug you've found.
11+
Doing so helps us to fix it ASAP 😃
12+
-->
13+
14+
## ✅ Checklist
15+
16+
- [ ] I have searched
17+
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues),
18+
and I am confident that this bug report is not a duplicate.
19+
- [ ] I have checked and my bug is present
20+
in [the latest version of this library](https://www.npmjs.com/package/react-native-dropdown-picker).
21+
- [ ] I have searched
22+
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
23+
and [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs),
24+
and I am confident that this is indeed a bug rather than simply something I
25+
don't know how to do (if so, make a question/help issue instead).
26+
- [ ] I am reporting a bug with the library, not requesting that more
27+
functionality is added to it (if so, make a feature request issue instead).
28+
- [ ] My bug comes from this library and not others, e.g. React Native or
29+
another dependency in my project.
30+
- [ ] I understand that each bug should be submitted in its own issue.
31+
Therefore, this issue will contain only one bug. I will submit any other bugs
32+
I have in their own, separate issues.
33+
34+
## ⚠️ The problem
35+
36+
### Desired (expected, correct) behaviour
37+
38+
<!--
39+
Please describe how this library should behave and act.
40+
This will be the proper behaviour that should be seen, but isn't because of the bug.
41+
-->
42+
43+
### Actual (unexpected, incorrect) behaviour
44+
45+
<!--
46+
Please describe how this library actually does act.
47+
This will be the undesired behaviour present because of the bug.
48+
-->
49+
50+
### Screenshots/screen recordings
51+
52+
<!--
53+
If possible, please include screenshots and/or screen recordings showing the bug.
54+
A picture speaks a thousand words.
55+
-->
56+
57+
### Log/error output
58+
59+
<!--
60+
If your bug produced any errors or logs, please copy and paste them here.
61+
-->
62+
63+
### 🔁 Minimal reproducible example
64+
65+
<!--
66+
Please include a link to a minimal reproducible example of the bug.
67+
This should be the minimum amount of code required to show the bug.
68+
Don't include any code or dependencies not needed for it to be present.
69+
If you found this bug in your project, remove everything other than the bare minimum required to reproduce and demonstrate this bug.
70+
71+
This example might be within:
72+
- an Expo Snack (https://snack.expo.dev)
73+
- a CodeSandbox (https://codesandbox.io)
74+
- a GitHub repo or gist
75+
76+
We recommend using an Expo Snack to create a minimal reproducible example.
77+
Here are some tips to help you: https://stackoverflow.com/help/mcve
78+
-->
79+
80+
Link to minimal reproducible example: <paste_link_here>
81+
82+
## 🏁 Final details
83+
84+
### Steps to fix
85+
86+
<!--
87+
Have you taken any steps to try to debug or fix this issue?
88+
If you have, what have you learnt while doing so? Did anything work?
89+
What insights and ideas can you give us into how we might fix this bug?
90+
Feel free to edit this library with patch-package (https://github.com/ds300/patch-package).
91+
See if you can debug or fix the issue and let us know what you find out!
92+
-->
93+
94+
### Additional context/info
95+
96+
<!--
97+
Please include any other information you think is relevant to this bug report.
98+
-->

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
name: "🚀 Feature request"
3+
about: Request a new feature to be added to this library.
4+
title: 'Feature request: '
5+
labels: [ 'feature request' ]
6+
---
7+
8+
<!--
9+
Thank you for making a feature request and helping to improve this library!
10+
Please fill out all the information below about your idea.
11+
Doing so helps us to assess its usefulness and feasibility and implement it ASAP 😃
12+
-->
13+
14+
## ✅ Checklist
15+
16+
- [ ] I have searched
17+
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues),
18+
and I am confident that this feature request is not a duplicate.
19+
- [ ] I have searched
20+
through [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
21+
and have
22+
read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website),
23+
and I am confident that this feature request is not implemented
24+
in [the latest version of this library](https://www.npmjs.com/package/react-native-dropdown-picker).
25+
- [ ] I am asking for some functionality to be added to this library. I am
26+
not seeking help or reporting a bug (if so, make a different type of issue).
27+
- [ ] I understand that each feature request should be submitted in its own
28+
issue. Therefore, this issue will contain only one feature request. I will
29+
submit any other feature requests I have in their own, separate issues.
30+
31+
## 🤔 Overview
32+
33+
### Summary
34+
35+
<!--
36+
Please give a brief overview and summary of this feature request.
37+
-->
38+
39+
### Usefulness
40+
41+
<!--
42+
Please explain in detail what value this feature request would add and why, to whom, and when it would be useful.
43+
-->
44+
45+
### User story
46+
47+
<!--
48+
Please write a user story encapsulating your proposed feature.
49+
See guidance at: https://www.atlassian.com/agile/project-management/user-stories
50+
-->
51+
52+
## 💡 Details
53+
54+
### How
55+
56+
<!--
57+
Please describe any ideas you have on how this feature could be implemented.
58+
How would you change this library to achieve it?
59+
Considering the architecture of this library and your desired goals for this feature, are there any design choices to consider?
60+
Have you tried implementing any of this functionality with patch-package (https://www.npmjs.com/package/patch-package)?
61+
If so, what did you learn?
62+
-->
63+
64+
### Similar/same functionality elsewhere
65+
66+
<!--
67+
Do any other libraries implement functionality the same as or similar to that which you're proposing?
68+
If so, which ones?
69+
Why would it still be useful for us to implement it as well if they already have something the same or similar?
70+
-->
71+
72+
### Possible alternatives
73+
74+
<!--
75+
Have you considered any alternative solutions, approaches, or features?
76+
Please describe them if so.
77+
Why is your proposed feature and solution better than these alternatives?
78+
-->
79+
80+
### Additional context/info
81+
82+
<!--
83+
Please include any other information you think is relevant to this feature request.
84+
-->

‎.github/ISSUE_TEMPLATE/QUESTION_OR_HELP.md

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
name: "🛟 Question or help"
3+
about: Ask a question or for help using the library.
4+
title: 'Question/help: '
5+
labels: [ 'help needed' ]
6+
---
7+
8+
<!--
9+
Thank you for your question or problem and for using this library!
10+
Please fill out all the information below to get help.
11+
Doing so helps us to assess your question or problem and help you 😃
12+
-->
13+
14+
## ✅ Checklist
15+
16+
- [ ] I have searched
17+
through [the other issues for this library](https://github.com/hossein-zare/react-native-dropdown-picker/issues),
18+
and I am confident that my question/problem is not a duplicate.
19+
- [ ] I have checked and
20+
read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website)
21+
to try to solve my question/problem by myself.
22+
- [ ] I have checked and
23+
read [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
24+
to try to solve my question/problem by myself.
25+
- [ ] I have checked and
26+
read [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-dropdown-picker)
27+
to try to solve my question/problem by myself.
28+
- [ ] I have
29+
examined [this library's examples](https://github.com/taeh98/react-native-dropdown-picker/tree/dev-5.x/examples)
30+
to try to solve my question/problem by myself.
31+
- [ ] My question/problem relates to this library and not others, e.g. React
32+
Native or another dependency in my project.
33+
- [ ] My question/problem is not a bug report or a feature request (if so,
34+
create a different type of issue).
35+
- [ ] I understand that each question/problem should be submitted in its own
36+
issue. Therefore, this issue will contain only one question/problem. I will
37+
submit any other questions/problems I have in their own, separate issues.
38+
39+
## 🔬 Research
40+
41+
### Relevant docs pages
42+
43+
<!--
44+
Please include the links to every docs page relevant to your question or problem.
45+
If there is no relevant information, please include links to the docs pages
46+
which should provide relevant information. Please describe the additional
47+
information they should contain. Please make an issue in the docs repo stating
48+
that this information should be added. The docs repo is: https://github.com/hossein-zare/react-native-dropdown-picker-website
49+
-->
50+
51+
### Relevant GitHub issues
52+
53+
<!--
54+
Please include links to every GitHub issue relevant to your question or problem.
55+
-->
56+
57+
### Relevant Stack Overflow questions
58+
59+
<!--
60+
Please include links to every Stack Overflow question relevant to your question or problem.
61+
-->
62+
63+
## ⚠️ The problem
64+
65+
### What I need help with
66+
67+
<!--
68+
Please describe what your issue is, the question you have, or the help you need.
69+
Maybe you want to customise a DropDownPicker in a certain way but don't know how?
70+
Maybe you're trying to do something and have copied the docs, but it isn't working?
71+
-->
72+
73+
### What I've tried already
74+
75+
<!--
76+
Please describe the steps you've taken to try to fix your issue yourself.
77+
This might be how you tried to research a question or tried to add a function.
78+
-->
79+
80+
### 🔁 Minimal reproducible example
81+
82+
<!--
83+
If your problem relates to you being unable to do something, provide an MRE.
84+
Remove everything other than the bare minimum required to demonstrate how you're
85+
trying to achieve your desired outcomes and how it isn't working.
86+
87+
This example might be within:
88+
- an Expo Snack (https://snack.expo.dev)
89+
- a CodeSandbox (https://codesandbox.io)
90+
- a GitHub repo or gist
91+
92+
We recommend using an Expo Snack to create a minimal reproducible example.
93+
Here are some tips to help you: https://stackoverflow.com/help/mcve
94+
-->
95+
96+
Link to minimal reproducible example: <paste_link_here>
97+
98+
## 🏁 Additional context/info
99+
100+
<!--
101+
Please include any other information you think is relevant to this problem/question/etc.
102+
Do you have any ideas or hunches on how to solve your issue?
103+
-->

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 📃 Documentation Issue
5+
url: https://github.com/hossein-zare/react-native-dropdown-picker-website
6+
about: >
7+
If this library's docs are incorrect or are missing something,
8+
please file an issue here.

0 commit comments

Comments
 (0)