Skip to content

Commit

Permalink
Merge pull request #1852 from DataDog/plousada/RUM-998/issue_forms
Browse files Browse the repository at this point in the history
Introduce gtihub issue forms
  • Loading branch information
plousada committed Feb 16, 2024
2 parents 13fb7a3 + 61c2c0c commit 659c865
Show file tree
Hide file tree
Showing 7 changed files with 285 additions and 50 deletions.
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/BugReport.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
name: Bug Report
description: Is the SDK not working as expected? Help us improve by submitting a bug report.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Ensure you go through our [troubleshooting](https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/troubleshooting/#debugging) page before creating a new issue.
Before getting started, if the problem is urgent or easier to investigate with access to your organization's data please use our [official support channel](https://www.datadoghq.com/support/).
- type: textarea
id: description
attributes:
label: Describe the bug
description: Provide a clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: |
Provide a self-contained piece of code demonstrating the bug.
For a more complex setup consider creating a small app that showcases the problem.
**Note** - Avoid sharing any business logic, credentials or tokens.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logcat logs
description: |
Please provide Logcat logs before, during and after the bug occurs.
validations:
required: false
- type: textarea
id: expected_behavior
attributes:
label: Expected behavior
description: Provide a clear and concise description of what you expected the SDK to do.
validations:
required: false
- type: input
id: affected_sdk_versions
attributes:
label: Affected SDK versions
description: What are the SDK versions you're seeing this bug in?
validations:
required: true
- type: input
id: last_working_sdk_version
attributes:
label: Latest working SDK version
description: What was the last SDK version that was working as expected?
validations:
required: true
- type: dropdown
id: checked_lastest_sdk
attributes:
label: Did you confirm if the latest SDK version fixes the bug?
options:
- 'Yes'
- 'No'
validations:
required: true
- type: input
id: kotlin_java_version
attributes:
label: Kotlin / Java version
- type: input
id: gradle_version
attributes:
label: Gradle / AGP version
- type: textarea
id: dependencies
attributes:
label: Other dependencies versions
description: |
Relevant third party dependency versions.
e.g. okhttp 4.11.0
- type: textarea
id: device_info
attributes:
label: Device Information
description: |
What are the common characteristics of devices you're seeing this bug in.
Specific models, OS versions, network state (wifi / cellular / offline), power state (plugged in / battery), etc.
validations:
required: false
- type: textarea
id: other_info
attributes:
label: Other relevant information
description: |
Other relevant information such as additional tooling in place, proxies, etc.
Anything that might be relevant for troubleshooting this bug.
85 changes: 85 additions & 0 deletions .github/ISSUE_TEMPLATE/CrashReport.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: Crash Report
description: Report crashes caused by the SDK.
labels: ["crash"]
body:
- type: markdown
attributes:
value: |
Report crashes caused by the SDK. Please try to be as detailed as possible.
Before getting started, if the problem is urgent please use our [official support channel](https://www.datadoghq.com/support/).
- type: textarea
id: stacktrace
attributes:
label: Stack trace
description: Please provide us with the stack trace of the crash or a crash report.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: |
Provide a self-contained piece of code demonstrating the crash if you can.
For a more complex setup consider creating a small app that showcases the problem.
**Note** - Avoid sharing any business logic, credentials or tokens.
validations:
required: false
- type: input
id: volume
attributes:
label: Volume
description: What percentage of your app sessions are impacted with this crash?
validations:
required: true
- type: input
id: affected_sdk_versions
attributes:
label: Affected SDK versions
description: What are the SDK versions you're seeing this crash in?
validations:
required: true
- type: input
id: last_working_sdk_version
attributes:
label: Latest working SDK version
description: If you know, what was the last SDK version where the crash did manifest itself?
validations:
required: true
- type: dropdown
id: checked_lastest_sdk
attributes:
label: Does the crash manifest in the latest SDK version?
options:
- 'Yes'
- 'No'
validations:
required: true
- type: input
id: kotlin_java_version
attributes:
label: Kotlin / Java version
- type: input
id: gradle_version
attributes:
label: Gradle / AGP version
- type: textarea
id: dependencies
attributes:
label: Other dependencies versions
description: |
Relevant third party dependency versions.
e.g. okhttp 4.11.0
- type: textarea
id: device_info
attributes:
label: Device Information
description: |
What are the common characteristics of devices you're seeing this crash in?
Specific models, OS versions, etc.
validations:
required: false
- type: textarea
id: other_info
attributes:
label: Other relevant information
description: Anything that might be relevant to pinpoint the source of the crash.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/FeatureRequest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature Request
description: Have an idea or need a new feature? Request it here.
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: Feature description
description: |
Provide a description for the feature request. Please include:
1. Use case
2. How the SDK currently delivers (or doesn't)
3. What would you like to see
validations:
required: true
- type: textarea
id: proposed_solution
attributes:
label: Proposed solution
description: |
How would you implement this?
Propose an idea, solution or reference implementation.
validations:
required: false
- type: textarea
id: other_info
attributes:
label: Other relevant information
description: Any other relevant information you'd like we take into consideration.
validations:
required: false

10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/Question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: Question
description: Do you just have a question about the SDK or a product? Ask here.
labels: ["question"]
body:
- type: textarea
id: question
attributes:
label: Question
validations:
required: true
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/SetupIssue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Setup Issue
description: Having a hard time setting up the SDK for the first time? Maybe a compilation issue or just nothing seems to be happening. Seek help with this.
labels: ["setup"]
body:
- type: markdown
attributes:
value: |
Before creating an issue, please ensure you go through the [troubleshooting page](https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/troubleshooting/#debugging).
- type: textarea
id: issue
attributes:
label: Describe the issue
description: Provide a clear and concise description of the issue. Include compilation logs and SDK debug logs if relevant.
validations:
required: true
- type: textarea
id: reproduction
attributes:
label: Reproduction steps
description: |
Provide a self-contained piece of code demonstrating the issue.
For a more complex setup consider creating a small app that showcases the problem.
**Note** - Avoid sharing any business logic, credentials or tokens.
validations:
required: true
- type: textarea
id: device_info
attributes:
label: Device Information
description: |
What are the common characteristics of devices you're seeing this issue in?
Simulators, specific models, OS versions, network state (wifi / cellular / offline), power state (plugged in / battery), etc.
validations:
required: false
- type: input
id: sdk_version
attributes:
label: SDK version
description: Which SDK version are you trying to use?
validations:
required: true
- type: input
id: kotlin_java_version
attributes:
label: Kotlin / Java version
- type: input
id: gradle_version
attributes:
label: Gradle / AGP version
- type: textarea
id: dependencies
attributes:
label: Other dependencies versions
description: |
Relevant third party dependency versions.
e.g. okhttp 4.11.0
- type: textarea
id: other_info
attributes:
label: Other relevant information
description: |
Other relevant information such as additional tooling in place, proxies, etc.
Anything that might be relevant for troubleshooting your setup.
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 659c865

Please sign in to comment.