Skip to content

Commit b3e1d49

Browse files
taeh98taeh98
committed
chore: added templates etc to enable contributions
1 parent 69a56ba commit b3e1d49

22 files changed

+923
-186
lines changed

‎.eslintrc.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ rules:
8181
- error
8282
- 300
8383
max-lines-per-function:
84-
- error
84+
- warn
8585
- max: 20
8686
no-console: error
8787
no-duplicate-imports: error
@@ -100,7 +100,7 @@ rules:
100100
- .js
101101
- .jsx
102102
react/prop-types: error
103-
sort-imports: error
103+
sort-imports: warn
104104
sort-keys:
105105
- error
106106
- asc

‎.github/ISSUE_TEMPLATE/BUG_REPORT.md

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,174 @@
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 am satisfied that this bug report is not a duplicate
19+
- [ ] I have checked that my bug is present
20+
in [the latest version of this library](https://www.npmjs.com/package/react-native-dropdown-picker)
21+
- [ ] I have
22+
searched [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 am satisfied 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+
- [ ] My bug comes from this library and not others, e.g. React Native or
27+
another dependency in my project
28+
- [ ] I understand that each bug should be submitted in its own issue.
29+
Therefore, this issue will contain only one bug, and I will submit any
30+
different bugs in their own, separate issues
31+
32+
## 🤔 Summary
33+
34+
<!--
35+
Please give a brief overview of what this bug is, what it does, and when it appears.
36+
-->
37+
38+
## ⚠️ The problem
39+
40+
### Desired (expected, correct) behaviour
41+
42+
<!--
43+
Please describe how this library should behave and act.
44+
This will be the proper behaviour that should be seen, but isn't because of the bug.
45+
-->
46+
47+
### Actual (unexpected, incorrect) behaviour
48+
49+
<!--
50+
Please describe how this library actually does act.
51+
This will be the undesired behaviour present because of the bug.
52+
-->
53+
54+
### Screenshots/screen recording
55+
56+
<!--
57+
If possible, please include screenshots and/or screen recordings showing the bug.
58+
A picture speaks a thousand words.
59+
-->
60+
61+
### Conditions
62+
63+
<!--
64+
Please describe the circumstances/conditions when you do and don't see this bug.
65+
-->
66+
67+
### Code
68+
69+
<!--
70+
Please copy and paste the relevant code in your project from which this bug arises.
71+
-->
72+
73+
### Log/error output
74+
75+
<!--
76+
If your bug produced terminal output showing any errors or logs, please copy and paste it here.
77+
-->
78+
79+
## 💻 Environment
80+
81+
### react-native-dropdown-picker version
82+
83+
<!--
84+
Please add the version of this library you were using when you saw this bug.
85+
-->
86+
87+
### Node and npm versions
88+
89+
<!--
90+
Please add the versions of Node and npm you were using when you saw this bug.
91+
-->
92+
93+
### React, React Native, and Expo versions
94+
95+
<!--
96+
Please add the versions of React, React Native, and Expo (if applicable) you were using when you saw this bug.
97+
-->
98+
99+
### Package.json contents
100+
101+
<!--
102+
Please copy and paste the contents of your package.json file here.
103+
-->
104+
105+
### Platform/s
106+
107+
<!--
108+
Please include the platform/s on which you've seen this bug.
109+
E.g. iPhone 15 running iOS 17.0.2
110+
-->
111+
112+
### JavaScript or TypeScript
113+
114+
<!--
115+
Is your project where you found the bug written in JavaScript or TypeScript?
116+
-->
117+
118+
### Class component or function component
119+
120+
<!--
121+
Is the component using a DropdownPicker where you saw the bug a class component or a function component?
122+
-->
123+
124+
## 🔁 Reproducing the bug
125+
126+
### Steps To Reproduce
127+
128+
1. Do this
129+
2. Then this
130+
3. ....
131+
4. Bug appears
132+
133+
<!--
134+
Please describe how you can reproduce this bug.
135+
It's important to ensure we can reproduce it.
136+
Without being able to do so, we won't be able to see it.
137+
We must be able to see it to be able to fix it.
138+
-->
139+
140+
### Minimal reproducible example
141+
142+
<!--
143+
Please include a link to a minimal reproducible example of the bug.
144+
This should be the minimum amount of code required to show the bug.
145+
Don't include any code or dependencies not needed for it to be present.
146+
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.
147+
148+
This example might be within:
149+
- an Expo Snack (https://snack.expo.dev)
150+
- a CodeSandbox (https://codesandbox.io)
151+
- a GitHub repo or gist
152+
153+
Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve
154+
-->
155+
156+
Link to minimal reproducible example: <example_link_here>
157+
158+
## 🏁 Final details
159+
160+
### Steps to fix
161+
162+
<!--
163+
Have you taken any steps to try to debug or fix this issue?
164+
If you have, what have you learnt while doing so? Did anything work?
165+
What insights and ideas can you give us into how we might fix this bug?
166+
Feel free to edit this library with patch-package (https://github.com/ds300/patch-package).
167+
If you can, see if you can debug or fix the issue and let us know what you find out!
168+
-->
169+
170+
### Additional context/info
171+
172+
<!--
173+
Please include any other information you think is relevant to this bug report.
174+
-->

‎.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
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 am satisfied 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
22+
read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website)
23+
and am satisfied that this feature request is not implemented in the most
24+
recent version of the library
25+
- [ ] I understand that each feature request should be submitted in its own
26+
issue. Therefore, this issue will contain only one feature request, and I will
27+
submit any different feature requests in their own, separate issues
28+
29+
## 🤔 Overview
30+
31+
### Summary
32+
33+
<!--
34+
Please give a brief overview of what this feature would add and why, to whom, and when it would be useful.
35+
-->
36+
37+
### User story
38+
39+
<!--
40+
Please write a user story describing your proposed feature.
41+
See guidance at: https://www.atlassian.com/agile/project-management/user-stories
42+
-->
43+
44+
## 💡 Details
45+
46+
### What
47+
48+
<!--
49+
Please describe what your new feature would do and how it should work.
50+
What would you like to happen?
51+
What would it add to this library?
52+
Please give some examples of how it would be used.
53+
-->
54+
55+
### Who
56+
57+
<!--
58+
Please describe who would find your feature useful.
59+
This will be an end user, e.g. the elderly person who might want a more visible dropdown with which to interact.
60+
This will likely be an agile persona: https://www.wrike.com/agile-guide/faq/what-are-agile-personas
61+
-->
62+
63+
### When
64+
65+
<!--
66+
Please describe the circumstances/conditions when a user would find this feature useful.
67+
Is your proposed feature specific to a platform? If so, which?
68+
-->
69+
70+
### Why
71+
72+
<!--
73+
Please describe why this feature should be implemented.
74+
Why would it be useful?
75+
Please provide any other relevant information on the **use case** you have in mind for this feature.
76+
-->
77+
78+
### How
79+
80+
<!--
81+
Please describe any ideas you have on how this feature could be implemented.
82+
How would you change this library to achieve it?
83+
Considering the architecture of this library and your desired goals for this feature, are there any design choices to think about?
84+
Have you tried implementing any of this functionality with patch-package (https://www.npmjs.com/package/patch-package)?
85+
If so, what did you learn from doing so?
86+
-->
87+
88+
## 🏁 Final details
89+
90+
### Similar/same functionality elsewhere
91+
92+
<!--
93+
Do any other libraries implement functionality the same as or similar to that which you're proposing?
94+
If so, which ones?
95+
Why would it still be useful for us to implement it as well if they already have something the same or similar?
96+
-->
97+
98+
### Possible alternatives
99+
100+
<!--
101+
Have you considered any alternative solutions, approaches, or features?
102+
Please describe them if so.
103+
Why is your proposed feature and solution better than these alternatives?
104+
-->
105+
106+
### Additional context/info
107+
108+
<!--
109+
Please include any other information you think is relevant to this feature request.
110+
-->

0 commit comments

Comments
 (0)