Skip to content

Commit

Permalink
chore: added pull request template to enable contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
taeh98 committed Oct 6, 2024
1 parent 09c6364 commit 4f803c2
Showing 1 changed file with 129 additions and 0 deletions.
129 changes: 129 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<!--
Thank you very much for your contribution!
We really appreciate your effort to improve this library for everyone.
Please fill out the rest of the information here.
It will help us to review, validate, and merge your changes 😃
-->

## ✅ Checklist

<!--
Please check the applicable items below. Please write any extra relevant context after an item.
-->

- [ ] I have
followed [this library's contributing guidance](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/CONTRIBUTING.md).
- [ ] I have
read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs),
and it still makes sense to make these changes.
- [ ] I have
read [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues),
and it still makes sense to make these changes.
- [ ] I
have [made an issue](https://github.com/hossein-zare/react-native-dropdown-picker/issues)
for the new feature/bug fix/etc this PR implements (or one already existed).
- [ ] I
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),
and everything works.
- [ ] My changes pass all the
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),
including the Prettier and ESLint checks.
- [ ] I
have [squashed all my changes into one commit](https://www.geeksforgeeks.org/git-squash/).
- [ ] My single commit message conforms
to [the Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary).
- [ ] I
have [kept my changes up-to-date with those in the
`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).
- [ ] I understand that each atomic change (e.g. fixing one bug or adding one
feature) [should be submitted in its own PR](https://learning-notes.mistermicheels.com/processes-techniques/small-commits-pull-requests/).
Therefore, this PR contains only one such atomic change. I will submit any
other atomic changes in their own, separate PRs.

## 👀 Relevant issue(s)

<!--
Fill out the issue/s your PR pertains to below. Delete as appropriate.
For example, "Fixes bug #111" or "Implements feature request #222".
-->

- Fixes bug #<Bug_GitHub_issue_number_goes_here>
- Implements feature request #<Feature_req_GitHub_issue_number_goes_here>

## 🚀️ Changes made

### What

<!--
Please give a brief overview of the changes this PR makes.
What does it change for users of the library?
-->

### Why

<!--
Please describe the motivation for this PR. Why are its changes needed?
-->

### How

<!--
How did you create the changes in this PR?
How did you implement them?
Why did you choose to implement them in the way you did?
-->

### Tests

<!--
Please describe how you tested these changes and this library as a whole after making them.
Please describe how a reviewer could reproduce your tests.
If possible, please also provide terminal output and/or screenshots demonstrating your tests and/or feature working correctly.
Please describe the outcome of your tests. Does everything work? Do you need help fixing an issue?
-->

## 📄 Documentation

### Relevant docs pages

<!--
Please include links to any pages in this library's docs that are relevant.
The docs can be found at: https://hossein-zare.github.io/react-native-dropdown-picker-website/docs
If none, type "N/A" and describe whether information should be added to the docs and why.
Then, open an issue in the docs repo to add more information needed to the docs.
-->

### JSDoc

- [ ] I updated all the JSDoc comments which were made incorrect by the
changes in this PR.
- [ ] I added JSDoc comments to all the classes, functions, files, etc that I
changed in this PR that did not already have JSDoc comments.

### Changes

<!--
Please describe whether the changes made in this PR necessitate changing this
library's docs. They might need to be updated and/or completed to add any
information you feel is missing or will become incorrect with the changes
made in this PR. If changes to the docs are required, please describe them here
and then also in a new issue to make them in the docs repo for this library:
https://github.com/hossein-zare/react-native-dropdown-picker-website
-->

## 🏁 Final details

### Help required

<!--
Please include any help you need. We'll be happy to provide it 😃
Maybe you need help to understand how certain parts of this library work?
Maybe you need help to fix a particular issue you're struggling to solve alone?
If you don't need any, say "N/A".
-->

### Additional context/info

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

0 comments on commit 4f803c2

Please sign in to comment.