From e0bc94d62d5d54903013082c49ff35e2965495e9 Mon Sep 17 00:00:00 2001 From: Sylvain Berfini Date: Mon, 18 Jul 2022 11:20:02 +0200 Subject: [PATCH] Updated github issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 60 +++++++++++++++++++--------- 1 file changed, 42 insertions(+), 18 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c90ffefde..85f3b6ff8 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,35 +7,59 @@ assignees: '' --- -**Describe the bug** +First of all, please say "Hi" or "Hello", it doesn't cost much. + + +1. **Describe the bug** (mandatory) + A clear and concise description of what the bug is. +Also, if applicable, **do you reproduce it with linphone-android latest release from the Play Store?** + **If the issue is about the SDK (build, issue, etc...) open the ticket in the [linphone-sdk](https://github.com/BelledonneCommunications/linphone-sdk) repository or one of it's submodules!** -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +2. **To Reproduce** (mandatory) + +Please detail steps to reproduce the behavior. + +3. **Expected behavior** (mandatory) -**Expected behavior** A clear and concise description of what you expected to happen. -**Please complete the following information** +4. **Please complete the following information** (mandatory) + - Device: [e.g. Samsung Note 20 Ultra] - - OS: [e.g. Android 11] - - Version of the App [e.g. 4.3.1] - - Version of the SDK [e.g 4.4.16] + - OS: [e.g. Android 12] + - Version of the App [e.g. 4.6.11] + - Version of the SDK [e.g 5.1.48] + - Where you did got it from (Play Store, F-Droid, local build) + - Please tell us if your Android is a Lineage OS or another variant. -**SDK logs** -Enable debug logs in advanced section of the settings, restart the app, reproduce the issue and then go to About page, click on "Send logs" and copy/paste the link here. +If you are using a SDK that isn't the latest release, please update first as it's likely your issue is already solved. -**Adb logcat logs** -In case of a crash of the app, please also provide the stack trace of the crash using adb logcat. +5. **SDK logs** (mandatory) + +Enable debug logs in advanced section of the settings, restart the app, reproduce the issue and then go back to advanced settings, click on "Send logs" and copy/paste the link here. + +It's also explained [in the README](https://github.com/BelledonneCommunications/linphone-android#behavior-issue). + +In case of a call issue, please attach logs from both devices! + +6. **Adb logcat logs** (mandatory if native crash) + +In case of a crash of the app, please also provide the symbolized stack trace of the crash using adb logcat. + +Here's the command for a arm64 device: `adb logcat | grep ndk-stack -sym /libs-debug/arm64-v8a/` + +For more information, please refer to [this section of the README](https://github.com/BelledonneCommunications/linphone-android#native-crash) file. + +7. **Screenshots** (optionnal) -**Screenshots** If applicable, add screenshots to help explain your problem. -**Additional context** +8. **Additional context** (optionnal) + Add any other context about the problem here. + + +Thank you in advance for filling bug reports properly! \ No newline at end of file