Skip to content

Commit f45e279

Browse files
committed
chore: added pull request template to enable contributions
1 parent 09c6364 commit f45e279

File tree

1 file changed

+128
-0
lines changed

1 file changed

+128
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
<!--
2+
Thank you very much for your contribution!
3+
We really appreciate your effort to improve this library for everyone.
4+
Please fill out the rest of the information here.
5+
It will help us to review, validate, and merge your changes 😃
6+
-->
7+
8+
## ✅ Checklist
9+
10+
<!--
11+
Please check the applicable items below. Please write any extra relevant context after an item.
12+
-->
13+
14+
- [ ] I have
15+
followed [this library's contributing guidance](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/CONTRIBUTING.md).
16+
- [ ] I have
17+
read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs),
18+
and it still makes sense to make these changes.
19+
- [ ] I have
20+
read [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues),
21+
and it still makes sense to make these changes.
22+
- [ ] I
23+
have [made an issue](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
24+
for the new feature/bug fix/etc this PR implements (or one already existed).
25+
- [ ] I
26+
have [tested my changes and this library as a whole with npm pack](https://dev.to/scooperdev/use-npm-pack-to-test-your-packages-locally-486e),
27+
and everything works.
28+
- [ ] My changes pass all the
29+
repo's [CI/status checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks),
30+
including the Prettier and ESLint checks.
31+
- [ ] I
32+
have [squashed all my changes into one commit](https://www.geeksforgeeks.org/git-squash/).
33+
- [ ] My single commit message conforms
34+
to [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary).
35+
- [ ] I
36+
have [kept my changes up-to-date with those in the
37+
`dev-5.x` (default)branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch).
38+
- [ ] I understand that each atomic change (e.g. fixing one bug or adding one
39+
feature) [should be submitted in its own PR](https://learning-notes.mistermicheels.com/processes-techniques/small-commits-pull-requests/).
40+
Therefore, this PR contains only one such atomic change, and I will submit any
41+
different changes in their own, separate PRs.
42+
43+
## 👀 Relevant issue(s)
44+
45+
<!--
46+
Fill out the issue/s your PR pertains to below. Delete as appropriate.
47+
For example, "Fixes bug #111" or "Implements feature request #222".
48+
-->
49+
50+
- Fixes bug #<Bug_GitHub_issue_number_goes_here>
51+
- Implements feature request #<Feature_req_GitHub_issue_number_goes_here>
52+
53+
## 🚀️ Changes made
54+
55+
### What
56+
57+
<!--
58+
Please give a brief overview of the changes this PR makes.
59+
What does it change for users of the library?
60+
-->
61+
62+
### Why
63+
64+
<!--
65+
Please describe the motivation for this PR. Why are its changes needed?
66+
-->
67+
68+
### How
69+
70+
<!--
71+
How did you create the changes in this PR?
72+
How did you implement them?
73+
Why did you choose to implement them in the way you did?
74+
-->
75+
76+
### Tests
77+
78+
<!--
79+
Please describe how you tested these changes and this library as a whole after making them.
80+
Please describe how a reviewer could reproduce your tests.
81+
If possible, please also provide terminal output and/or screenshots demonstrating your tests and/or feature working correctly.
82+
Please describe the outcome of your tests. Does everything work? Do you need help fixing an issue?
83+
-->
84+
85+
## 📄 Documentation
86+
87+
### Relevant docs pages
88+
89+
<!--
90+
Please include links to any pages in this library's docs that are relevant.
91+
The docs can be found at: https://hossein-zare.github.io/react-native-dropdown-picker-website/docs
92+
If none, type "N/A" and describe whether information should be added to the docs and why.
93+
-->
94+
95+
### JSDoc
96+
97+
- [ ] I updated all the JSDoc comments which were made incorrect by the
98+
changes in this PR.
99+
- [ ] I added JSDoc comments to all the classes, functions, files, etc that I
100+
changed in this PR that did not already have JSDoc comments.
101+
102+
### Changes
103+
104+
<!--
105+
Please describe whether the changes made in this PR necessitate changing this
106+
library's docs. They might need to be updated and/or completed to add any
107+
information you feel is missing or will become incorrect with the changes
108+
made in this PR. If changes to the docs are required, please describe them and
109+
then make a PR in the docs repo for this library implementing them:
110+
https://github.com/hossein-zare/react-native-dropdown-picker-website
111+
-->
112+
113+
## 🏁 Final details
114+
115+
### Help required
116+
117+
<!--
118+
Please include any help you need. We'll be happy to provide it 😃
119+
Maybe you need help to understand how certain parts of this library work?
120+
Maybe you need help to fix a particular issue you're struggling to solve alone?
121+
If you don't need any, say "N/A".
122+
-->
123+
124+
### Additional context/info
125+
126+
<!--
127+
Please include any other information you think is relevant to this PR.
128+
-->

0 commit comments

Comments
 (0)