From b1ae8f35e343e088d6219db05d50085737c74a7d Mon Sep 17 00:00:00 2001 From: t <28008958+taeh98@users.noreply.github.com> Date: Sat, 7 Oct 2023 02:13:49 +0100 Subject: [PATCH] chore: added templates etc to enable contributions --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 174 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md | 110 +++++++++++++ .github/ISSUE_TEMPLATE/QUESTION_OR_HELP.md | 149 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 + .github/PULL_REQUEST_TEMPLATE.md | 118 ++++++++++++++ 5 files changed, 559 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md create mode 100644 .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md create mode 100644 .github/ISSUE_TEMPLATE/QUESTION_OR_HELP.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..ee5a2c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,174 @@ +--- +name: "🐛 Bug Report" +about: Report a bug in the library. +title: 'Bug: ' +labels: [ 'bug report' ] +--- + + + +## ✅ 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 + + + +## ⚠️ The problem + +### Desired (expected, correct) behaviour + + + +### Actual (unexpected, incorrect) behaviour + + + +### Screenshots/screen recording + + + +### Conditions + + + +### Code + + + +### Log/error output + + + +## 💻 Environment + +### react-native-dropdown-picker version + + + +### Node and npm versions + + + +### React, React Native, and Expo versions + + + +### Package.json contents + + + +### Platform/s + + + +### JavaScript or TypeScript + + + +### Class component or function component + + + +## 🔁 Reproducing the bug + +### Steps To Reproduce + +1. Do this +2. Then this +3. .... +4. Bug appears + + + +### Minimal reproducible example + + + +Link to minimal reproducible example: + +## 🏁 Final details + +### Steps to fix + + + +### Additional context/info + + diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md new file mode 100644 index 0000000..f20c527 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md @@ -0,0 +1,110 @@ +--- +name: "🚀 Feature request" +about: Request a new feature to be added to this library. +title: 'Feature request: ' +labels: [ 'feature request' ] +--- + + + +## ✅ 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 + + + +### User story + + + +## 💡 Details + +### What + + + +### Who + + + +### When + + + +### Why + + + +### How + + + +## 🏁 Final details + +### Similar/same functionality elsewhere + + + +### Possible alternatives + + + +### Additional context/info + + diff --git a/.github/ISSUE_TEMPLATE/QUESTION_OR_HELP.md b/.github/ISSUE_TEMPLATE/QUESTION_OR_HELP.md new file mode 100644 index 0000000..454d67b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION_OR_HELP.md @@ -0,0 +1,149 @@ +--- +name: "❓ Question or help" +about: Ask a question or for help using the library. +title: 'Question/help: ' +labels: [ 'help needed' ] +--- + + + +## ✅ Checklist + +- [ ] I have searched through + the [other issues for this library](https://github.com/hossein-zare/react-native-dropdown-picker/issues) + and am satisfied that my problem is not a duplicate. +- [ ] I have checked and + read [this library's docs](https://hossein-zare.github.io/react-native-dropdown-picker-website) + to try and resolve my problem by myself +- [ ] I have checked and + read [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues) + to try and resolve my problem by myself +- [ ] I have checked and + read [Stack Overflow](https://stackoverflow.com/questions/tagged/react-native-dropdown-picker) + to try and resolve my problem by myself +- [ ] My problem relates to this library and not others, e.g. React Native or + another dependency in my project +- [ ] I understand that each question/problem should be submitted in its own + issue. Therefore, this issue will contain only one such problem, and I will + submit any different problems in their own, separate issues + +### Relevant docs pages + + + +### Relevant issues + + + +### Relevant Stack Overflow questions + + + +## 🤔 Summary + +### Overview + + + +### User story + + + +## ⚠️ The problem + +### What I need help with + + + +### Code + + + +### Log/error output + + + +### Screenshots + + + +## 💻 Environment + +### react-native-dropdown-picker version + + + +### Node and npm versions + + + +### React, React Native, and Expo versions + + + +### Package.json contents + + + +### Platform/s + + + +### JavaScript or TypeScript + + + +### Class component or function component + + + +## 🏁 Additional context/info + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..576316e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +--- +blank_issues_enabled: false +contact_links: + - name: 📃 Documentation Issue + url: https://github.com/hossein-zare/react-native-dropdown-picker-website + about: > + If this library's docs are incorrect or are missing something, + please file an issue here. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d2605c4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,118 @@ + + +## ✅ Checklist + + + +- [ ] I have + followed [the 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 is still sensible to make these changes +- [ ] I have + read [this library's GitHub issues](https://github.com/hossein-zare/react-native-dropdown-picker/issues), + and it is still sensible to make these changes +- [ ] + I [made an issue](https://github.com/hossein-zare/react-native-dropdown-picker/issues) + for the new feature/bug fix/etc this PR implements +- [ ] + This [PR is linked to its relevant issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) +- [ ] 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 added/changed automated tests to ensure my feature works correctly and + continues to do so +- [ ] 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) +- [ ] My changes do not require changing this library's docs: they are + up-to-date and comprehensive even with my changes +- [ ] My changes require this library's docs to be updated and/or completed to + include all relevant and up-to-date information +- [ ] I have made a separate PR + in [the docs repo](https://github.com/hossein-zare/react-native-dropdown-picker-website) + to update them in light of this PR +- [ ] I understand that each atomic change (e.g. fixing one bug or adding one + feature) should be submitted in its own PR. Therefore, this PR will contain + only one such atomic change, and I will submit any different changes in their + own, separate PRs + +## 👀 Relevant issue(s) + + + +- Fixes bug # +- Implements feature request # +- Fixes bug # + +## 🚀️ Changes made + +### What + + + +### Why + + + +### How + + + +### Tests + + + +## 🏁 Final details + +### Relevant docs pages + + + +### Help required + + + +### Additional context/info + +