diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..085b862 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,73 @@ +--- +name: Bug report +about: Create a report to help us improve nearby_service +title: "[BUG]: " +labels: bug +assignees: ksenia312 + +--- + +### **Bug Description** + +Provide a clear description of the bug + +### **Steps to Reproduce** + +List the steps that reproduce the behavior: + +1. Initialize the package: (e.g., `_nearbyService.initialize();`) +2. Attempt to discover peers: (e.g., `_nearbyService.discover();`) +3. Observe the issue: (e.g., Connection drops, no data received, etc.) + +### **Environment** + +Please provide details about the environment where the bug occurred: + +- **Platform:** [e.g., Android, iOS] +- **OS Version:** [e.g., Android 10, iOS 14.4] +- **Device Model:** [e.g., Samsung Galaxy S10, iPhone 14] +- **Package Version:** [e.g., 0.0.9] + +### **Code Snippet** + +If applicable, provide a code snippet that reproduces the issue: + +```dart +// Example code that triggers the bug +final result = await _nearbyService.connectById(deviceId); +if (result) { + ... +} +``` + +### Logs + +If available, provide any relevant logs or error messages that might help in diagnosing the problem: + +```bash +E/NearbyService(28254): WifiManager is not initialized. Please call 'initialize()' first +I/flutter (28254): [NearbyService]: Got error from native platform with status=NO_INITIALIZATION +``` + +### **Network Conditions** + +Describe the network conditions and configuration when the issue occurred (if relevant): + +- **Wi-Fi Status:** + - [ ] Enabled and connected to a network + - [ ] Enabled but not connected + - [ ] Disabled + +- **Mobile Hotspot:** + - [ ] Enabled + - [ ] Disabled + +- **Wi-Fi Direct Status:** + - [ ] Enabled and connected to one or many peers + - [ ] Enabled but not connected to peers + - [ ] Disabled + +- **Additional Network Information:** (e.g., any network configurations or limitations that might be relevant) + +--- +Your effort is appreciated šŸ’— \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..f4fa1aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,21 @@ +--- +name: Feature request +about: Suggest an idea for nearby_service +title: "[FEATURE-REQUEST]: " +labels: enhancement +assignees: ksenia312 + +--- + +### Is your feature request related to a problem? Please describe. +Description of the problem + +### Describe the solution you would like +A clear and concise description of what you want to happen + +### Additional context +Add any other context or screenshots about the feature request here + +--- + +Your effort is appreciated šŸ’— \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question-about-source-code.md b/.github/ISSUE_TEMPLATE/question_about_source_code.md similarity index 61% rename from .github/ISSUE_TEMPLATE/question-about-source-code.md rename to .github/ISSUE_TEMPLATE/question_about_source_code.md index 3553143..cfb14f4 100644 --- a/.github/ISSUE_TEMPLATE/question-about-source-code.md +++ b/.github/ISSUE_TEMPLATE/question_about_source_code.md @@ -11,10 +11,10 @@ assignees: ksenia312 Provide your question here ### Source Code Path -Specify the path to the source code you are referring to. (e.g., `lib/src/platforms/android/nearby_android_service.dart`) +Specify the path to the source code (e.g., `lib/src/platforms/android/nearby_android_service.dart`) ### Code Snippet -Include a code snippet from the source code in question. Ensure to provide enough context to understand the issue. +Include a code snippet from the source code in question ```dart // Example source code snippet @@ -23,3 +23,6 @@ Include a code snippet from the source code in question. Ensure to provide enoug return _socketService.send(message); } ``` +--- + +Your effort is appreciated šŸ’— \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question_about_usage.md b/.github/ISSUE_TEMPLATE/question_about_usage.md new file mode 100644 index 0000000..83de80c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question_about_usage.md @@ -0,0 +1,23 @@ +--- +name: Question about usage +about: Ask a question about nearby_service usage +title: "[QUESTION]: " +labels: question +assignees: ksenia312 + +--- + +### Question: +Provide your question here (e.g., ā€œI’m not sure how to pass the peer ID to the `connectById()` method.ā€) + +### Code Snippet: +Provide any relevant code snippets where you are using the API + +```dart +// Example code where the issue occurs +_nearbyService.initialize(); +_nearbyService.connectById(deviceId); +``` +--- + +Your effort is appreciated šŸ’— \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..c59003c --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +### Description + +Provide a clear description of the bug fix or improvement implemented in this pull +request + +### Related Issue + +If this pull request addresses an existing issue, please provide the issue number. If it is related +to an issue, mention it here + +- Issue Number: #[Issue Number] + +### Checklist + +Please ensure the following before submitting your pull request: + +- [ ] I have searched for existing issues to ensure this fix or improvement has not already been + addressed +- [ ] I have tested the changes locally +- [ ] I have added appropriate labels to this pull request (e.g., `bug`, `enhancement`) + +### Screenshots + +If applicable, include screenshots to demonstrate the changes or to help clarify the implementation + +--- + +Your effort is appreciated šŸ’—