Skip to content

Commit

Permalink
chore: update issue templates (#389)
Browse files Browse the repository at this point in the history
Co-authored-by: Caio Moreira <[email protected]>
  • Loading branch information
jokerttu and caio1985 authored Feb 4, 2025
1 parent 8e888fd commit 7cc4b36
Show file tree
Hide file tree
Showing 6 changed files with 191 additions and 20 deletions.
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

107 changes: 107 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
name: Bug report
description: Report an issue, including all necessary details for reproduction and debugging.
title: '[Bug]: '
labels: 'type: bug, triage me'
body:
- type: markdown
attributes:
value: |
Thank you for using googlemaps/react-native-navigation-sdk!
If you believe this bug is related to a feature in our native SDKs or you have question about how features should be used, please create an issue in the [support console](https://cloud.google.com/support/).
This will ensure a timely response.
Links to the official native SDKs supported by Google Support:
- [Android](https://developers.google.com/maps/documentation/navigation/android-sdk)
- [iOS](https://developers.google.com/maps/documentation/navigation/ios-sdk)
Discover additional support services for the Google Maps Platform, including developer communities, technical guidance, and expert support at the Google Maps Platform [support resources page](https://developers.google.com/maps/support/).
If your bug or feature request is not related to this particular react native library, please visit the Google Maps Platform [issue trackers](https://developers.google.com/maps/support/#issue_tracker).
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please ensure your bug is not already reported in [existing issues](https://github.com/googlemaps/react-native-navigation-sdk/issues).
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Description of the bug
description: Provide a clear and concise description of the bug.
validations:
required: true
- type: input
attributes:
label: React Native version
description: Provide the React Native version used in your project.
validations:
required: true
- type: input
attributes:
label: React version
description: Provide the React version used in your project.
validations:
required: true
- type: input
attributes:
label: Package version
description: Provide the version of googlemaps/react-native-navigation-sdk.
validations:
required: true
- type: checkboxes
attributes:
label: Native SDK versions
description: Confirm that you have not changed the version of the native SDKs.
options:
- label: I haven't changed the version of the native SDKs
required: true
- type: textarea
attributes:
label: React Native Doctor Output
description: |
Run `npx react-native doctor` in your projectq and paste the output below.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
Provide a step-by-step description of how to reproduce the issue.
Use bullet points or numbers for clarity.
If you are not able to reproduce the issue, please provide as much context as possible.
placeholder: |
1. In this environment...
2. With this config...
3. Run '...'
4. See error...
validations:
required: true
- type: textarea
attributes:
label: Expected vs Actual Behavior
description: |
Describe what you expected to happen and what actually happened.
Also provide any error messages or logs that you see. Also check Android logcat and/or iOS console logs for any relevant information.
validations:
required: true
- type: textarea
attributes:
label: Code Sample
description: |
Provide a minimal reproducible example that shows the problem.
Use a code block for formatting.
Without this we will unlikely be able to progress on the issue,
as we need to be able to reproduce the problem locally.
value: |
```javascript
// Example code here
```
validations:
required: true
- type: textarea
attributes:
label: Additional Context
description: Provide any other context, logs, or screenshots that might be relevant.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Feature request
description: Suggest a feature or improvement for this package
title: '[Feature request]: '
labels: 'type: feature request, triage me'
body:
- type: markdown
attributes:
value: |
Thank you for suggesting an improvement for googlemaps/react-native-navigation-sdk!
If you have a support contract with Google, please create an issue in the [support console](https://cloud.google.com/support/). This will ensure a timely response.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please ensure your feature request is not already covered in [existing issues](https://github.com/googlemaps/react-native-navigation-sdk/issues).
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Use case
description: |
Please tell us the problem you are running into that led to you wanting
a new feature.
Is your feature request related to a problem? Please give a clear and
concise description of what the problem is.
Describe the alternative solutions you've considered. Is there a package
existing that already solves this?
validations:
required: true
- type: textarea
attributes:
label: Proposal
description: |
Briefly but precisely describe what you would like the package to be able to do.
Consider attaching something showing what you are imagining:
* images
* videos
* code samples
validations:
required: true
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/support_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Support request
about:
If you have a support contract with Google, please create an issue in the Google
Cloud Support console.
title: '[Support Request]: '
labels: 'triage me, type: question'
assignees: ''
---

**PLEASE READ**

If you have a support contract with Google and questions related to how Navigation SDK works and its features should be used, please create an issue in the [support console](https://cloud.google.com/support/). This will ensure a timely response.

Links to the official native SDKs:
- [Android](https://developers.google.com/maps/documentation/navigation/android-sdk)
- [iOS](https://developers.google.com/maps/documentation/navigation/ios-sdk)

Discover additional support services for the Google Maps Platform, including developer communities, technical guidance, and expert support at the Google Maps Platform [support resources page](https://developers.google.com/maps/support/).

If your bug or feature request is not related to this particular library, please visit the Google Maps Platform [issue trackers](https://developers.google.com/maps/support/#issue_tracker).

Check for answers on StackOverflow with the [google-maps](http://stackoverflow.com/questions/tagged/google-maps) tag.

---
18 changes: 14 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
Fixes #<issue_number_goes_here>
*Replace this paragraph with a description of what this PR is changing or adding, and why. Consider including before/after screenshots.*

> It's a good idea to open an issue first for discussion.
*List which issues are fixed by this PR. You must list at least one issue. An issue is not required if the PR fixes something trivial like a typo.*

- [ ] Tests pass
- [ ] Appropriate changes to documentation are included in the PR
## Pre-launch Checklist

- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
- [ ] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description above.
- [ ] I updated/added relevant documentation
- [ ] I added new tests to check the change I am making
- [ ] All existing and new tests are passing.

<!-- Links -->
[Contributor Guide]: https://github.com/googlemaps/react-native-navigation-sdk/blob/main/CONTRIBUTING.md
[CLA]: https://cla.developers.google.com/
1 change: 1 addition & 0 deletions scripts/addlicense.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ addlicense -f header_template.txt $@ \
--ignore "lib/**" \
--ignore "coverage/**" \
--ignore ".yarn/**" \
--ignore ".github/ISSUE_TEMPLATE/**" \
.

0 comments on commit 7cc4b36

Please sign in to comment.