Skip to content

Commit 7cc4b36

Browse files
jokerttucaio1985
jokerttu
and
caio1985
authored
chore: update issue templates (#389)
Co-authored-by: Caio Moreira <[email protected]>
1 parent 8e888fd commit 7cc4b36

File tree

6 files changed

+191
-20
lines changed

6 files changed

+191
-20
lines changed

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
name: Bug report
2+
description: Report an issue, including all necessary details for reproduction and debugging.
3+
title: '[Bug]: '
4+
labels: 'type: bug, triage me'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for using googlemaps/react-native-navigation-sdk!
10+
11+
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/).
12+
This will ensure a timely response.
13+
14+
Links to the official native SDKs supported by Google Support:
15+
- [Android](https://developers.google.com/maps/documentation/navigation/android-sdk)
16+
- [iOS](https://developers.google.com/maps/documentation/navigation/ios-sdk)
17+
18+
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/).
19+
20+
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).
21+
- type: checkboxes
22+
attributes:
23+
label: Is there an existing issue for this?
24+
description: Please ensure your bug is not already reported in [existing issues](https://github.com/googlemaps/react-native-navigation-sdk/issues).
25+
options:
26+
- label: I have searched the existing issues
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Description of the bug
31+
description: Provide a clear and concise description of the bug.
32+
validations:
33+
required: true
34+
- type: input
35+
attributes:
36+
label: React Native version
37+
description: Provide the React Native version used in your project.
38+
validations:
39+
required: true
40+
- type: input
41+
attributes:
42+
label: React version
43+
description: Provide the React version used in your project.
44+
validations:
45+
required: true
46+
- type: input
47+
attributes:
48+
label: Package version
49+
description: Provide the version of googlemaps/react-native-navigation-sdk.
50+
validations:
51+
required: true
52+
- type: checkboxes
53+
attributes:
54+
label: Native SDK versions
55+
description: Confirm that you have not changed the version of the native SDKs.
56+
options:
57+
- label: I haven't changed the version of the native SDKs
58+
required: true
59+
- type: textarea
60+
attributes:
61+
label: React Native Doctor Output
62+
description: |
63+
Run `npx react-native doctor` in your projectq and paste the output below.
64+
validations:
65+
required: true
66+
- type: textarea
67+
attributes:
68+
label: Steps to reproduce
69+
description: |
70+
Provide a step-by-step description of how to reproduce the issue.
71+
Use bullet points or numbers for clarity.
72+
If you are not able to reproduce the issue, please provide as much context as possible.
73+
placeholder: |
74+
1. In this environment...
75+
2. With this config...
76+
3. Run '...'
77+
4. See error...
78+
validations:
79+
required: true
80+
- type: textarea
81+
attributes:
82+
label: Expected vs Actual Behavior
83+
description: |
84+
Describe what you expected to happen and what actually happened.
85+
86+
Also provide any error messages or logs that you see. Also check Android logcat and/or iOS console logs for any relevant information.
87+
validations:
88+
required: true
89+
- type: textarea
90+
attributes:
91+
label: Code Sample
92+
description: |
93+
Provide a minimal reproducible example that shows the problem.
94+
Use a code block for formatting.
95+
96+
Without this we will unlikely be able to progress on the issue,
97+
as we need to be able to reproduce the problem locally.
98+
value: |
99+
```javascript
100+
// Example code here
101+
```
102+
validations:
103+
required: true
104+
- type: textarea
105+
attributes:
106+
label: Additional Context
107+
description: Provide any other context, logs, or screenshots that might be relevant.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: Feature request
2+
description: Suggest a feature or improvement for this package
3+
title: '[Feature request]: '
4+
labels: 'type: feature request, triage me'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting an improvement for googlemaps/react-native-navigation-sdk!
10+
11+
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.
12+
- type: checkboxes
13+
attributes:
14+
label: Is there an existing issue for this?
15+
description: Please ensure your feature request is not already covered in [existing issues](https://github.com/googlemaps/react-native-navigation-sdk/issues).
16+
options:
17+
- label: I have searched the existing issues
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Use case
22+
description: |
23+
Please tell us the problem you are running into that led to you wanting
24+
a new feature.
25+
26+
Is your feature request related to a problem? Please give a clear and
27+
concise description of what the problem is.
28+
29+
Describe the alternative solutions you've considered. Is there a package
30+
existing that already solves this?
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Proposal
36+
description: |
37+
Briefly but precisely describe what you would like the package to be able to do.
38+
39+
Consider attaching something showing what you are imagining:
40+
* images
41+
* videos
42+
* code samples
43+
validations:
44+
required: true

‎.github/ISSUE_TEMPLATE/support_request.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
name: Support request
3+
about:
4+
If you have a support contract with Google, please create an issue in the Google
5+
Cloud Support console.
6+
title: '[Support Request]: '
7+
labels: 'triage me, type: question'
8+
assignees: ''
9+
---
10+
11+
**PLEASE READ**
12+
13+
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.
14+
15+
Links to the official native SDKs:
16+
- [Android](https://developers.google.com/maps/documentation/navigation/android-sdk)
17+
- [iOS](https://developers.google.com/maps/documentation/navigation/ios-sdk)
18+
19+
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/).
20+
21+
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).
22+
23+
Check for answers on StackOverflow with the [google-maps](http://stackoverflow.com/questions/tagged/google-maps) tag.
24+
25+
---

‎.github/PULL_REQUEST_TEMPLATE.md‎

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

3-
> It's a good idea to open an issue first for discussion.
3+
*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.*
44

5-
- [ ] Tests pass
6-
- [ ] Appropriate changes to documentation are included in the PR
5+
## Pre-launch Checklist
6+
7+
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
8+
- [ ] I signed the [CLA].
9+
- [ ] I listed at least one issue that this PR fixes in the description above.
10+
- [ ] I updated/added relevant documentation
11+
- [ ] I added new tests to check the change I am making
12+
- [ ] All existing and new tests are passing.
13+
14+
<!-- Links -->
15+
[Contributor Guide]: https://github.com/googlemaps/react-native-navigation-sdk/blob/main/CONTRIBUTING.md
16+
[CLA]: https://cla.developers.google.com/

‎scripts/addlicense.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,5 @@ addlicense -f header_template.txt $@ \
2424
--ignore "lib/**" \
2525
--ignore "coverage/**" \
2626
--ignore ".yarn/**" \
27+
--ignore ".github/ISSUE_TEMPLATE/**" \
2728
.

0 commit comments

Comments
 (0)