Skip to content

Commit

Permalink
Issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
christocracy committed Jan 20, 2025
1 parent dadf83e commit 701a524
Show file tree
Hide file tree
Showing 2 changed files with 139 additions and 0 deletions.
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this support request.
- type: checkboxes
id: terms
attributes:
label: Required Reading
description: I have read the following Wikis [Philosophy of Operation](../wiki//Philosophy-of-Operation) and [Debugging](../wiki/Debugging). I am aware of the [API Documentation](https://transistorsoft.github.io/react-native-background-geolocation/)
options:
- label: Confirmed
required: true
- type: input
id: version
attributes:
label: Plugin Version
description: What version of our software are you running?
placeholder: Consult your package.json
validations:
required: true
- type: checkboxes
id: os
attributes:
label: Mobile operating-system(s)
description: Which mobile operating-system(s) is this issue reported upon?
options:
- label: iOS
- label: Android
- type: input
id: device-info
attributes:
label: Device Manufacturer(s) and Model(s)
description: What is the device model(s) and manufacturer(s)
placeholder: eg Google Pixel 6, iPhone 13 Pro
validations:
required: true
- type: input
id: device-os
attributes:
label: Device operating-systems(s)
description: Affected device operating system
placeholder: eg iOS 18.1, Android 13
validations:
required: true
- type: input
id: framework-version
attributes:
label: React Native / Expo version
description: What version React Native / Expo are you using
placeholder: "eg: 0.76.6, Expo 52 (consult your package.json)"
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: "Something unexpected happened!"
validations:
required: true
- type: textarea
id: config
attributes:
label: Plugin Code and/or Config
description: Provide the Config you're using with the `BackgroundGeolocation.ready(config)` method along with any other relevant code.
placeholder: "Paste your Config or code here, eg: BackgroundGeolocation.ready(config).\n\nYour code will be automatically syntax-highlighted"
render: typescript
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
placeholder: "include iOS / Android logs\n- $ adb logcat -s TSLocationManager:V\n- ios XCode logs\n- Logs from BackgroundGeolocation.emailLog(address)"
render: shell

58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/2-help-wanted.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Help Wanted
description: I need assistance
title: "[Help Wanted]: "
labels: ["triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this support request.
- type: checkboxes
id: terms
attributes:
label: Required Reading
description: I have read the following Wikis [Philosophy of Operation](../wiki//Philosophy-of-Operation) and [Debugging](../wiki/Debugging). I am aware of the [API Documentation](https://transistorsoft.github.io/react-native-background-geolocation/)
options:
- label: Confirmed
required: true
- type: input
id: version
attributes:
label: Plugin Version
description: What version of our software are you running?
placeholder: Consult your package.json
validations:
required: true
- type: checkboxes
id: os
attributes:
label: Mobile operating-system(s)
description: Which mobile operating-system(s) is this about?
options:
- label: iOS
- label: Android
- type: textarea
id: what-happened
attributes:
label: What do you require assistance about?
validations:
required: true
- type: textarea
id: config
attributes:
label: "[Optional] Plugin Code and/or Config"
description: Provide the Config you're using with the `BackgroundGeolocation.ready(config)` method along with any other relevant code.
placeholder: "Paste your Config or code here, eg: BackgroundGeolocation.ready(config).\n\nYour code will be automatically syntax-highlighted"
render: typescript
validations:
required: false
- type: textarea
id: logs
attributes:
label: "[Optional] Relevant log output"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
placeholder: "include iOS / Android logs\n- $ adb logcat -s TSLocationManager:V\n- ios XCode logs\n- Logs from BackgroundGeolocation.emailLog(address)"
render: shell
validations:
required: false

0 comments on commit 701a524

Please sign in to comment.