From 710c9dcf95d99c05e71dfba12f329bd97c0ef13d Mon Sep 17 00:00:00 2001 From: Joonas Kerttula Date: Tue, 7 Jan 2025 12:42:55 +0200 Subject: [PATCH 1/3] chore: update issue templates --- .github/ISSUE_TEMPLATE.md | 16 ---- .github/ISSUE_TEMPLATE/bug_report.yml | 95 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 44 ++++++++++ .github/ISSUE_TEMPLATE/support_request.md | 21 +++++ .github/PULL_REQUEST_TEMPLATE.md | 18 +++- scripts/addlicense.sh | 1 + 6 files changed, 175 insertions(+), 20 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/support_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 3c52212..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,16 +0,0 @@ -## Expected Behavior - - -## Actual Behavior - - -## Steps to Reproduce the Problem - -1. -1. -1. - -## Specifications - -- Version: -- Platform: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..ed70b96 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,95 @@ +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 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. + + 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: 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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..172a869 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/support_request.md b/.github/ISSUE_TEMPLATE/support_request.md new file mode 100644 index 0000000..f5ea109 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support_request.md @@ -0,0 +1,21 @@ +--- +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, please create an issue in the [support console](https://cloud.google.com/support/). This will ensure a timely response. + +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. + +--- diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 00550b6..a026e20 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,16 @@ -Fixes # +*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 \ No newline at end of file +## 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. + + +[Contributor Guide]: https://github.com/googlemaps/react-native-navigation-sdk/blob/main/CONTRIBUTING.md +[CLA]: https://cla.developers.google.com/ \ No newline at end of file diff --git a/scripts/addlicense.sh b/scripts/addlicense.sh index 7751d21..bd7b600 100755 --- a/scripts/addlicense.sh +++ b/scripts/addlicense.sh @@ -24,4 +24,5 @@ addlicense -f header_template.txt $@ \ --ignore "lib/**" \ --ignore "coverage/**" \ --ignore ".yarn/**" \ + --ignore ".github/ISSUE_TEMPLATE/**" \ . From 81ecf85bdbb193e1e4f55c3b4bff453cbcba04d9 Mon Sep 17 00:00:00 2001 From: Caio Moreira Date: Tue, 7 Jan 2025 15:45:03 -0300 Subject: [PATCH 2/3] Update support_request.md Added more clarification and links to the official documentation. --- .github/ISSUE_TEMPLATE/support_request.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/support_request.md b/.github/ISSUE_TEMPLATE/support_request.md index f5ea109..1e3d161 100644 --- a/.github/ISSUE_TEMPLATE/support_request.md +++ b/.github/ISSUE_TEMPLATE/support_request.md @@ -10,7 +10,11 @@ assignees: '' **PLEASE READ** -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. +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/). From b323f3f4b4c5a3ed5d4e1a3f8592d580198edfd4 Mon Sep 17 00:00:00 2001 From: Joonas Kerttula Date: Wed, 8 Jan 2025 14:06:20 +0200 Subject: [PATCH 3/3] chore: update bug report template --- .github/ISSUE_TEMPLATE/bug_report.yml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ed70b96..2787c7e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -8,7 +8,12 @@ body: value: | Thank you for using 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. + 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/). @@ -44,6 +49,13 @@ body: 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