chore: improve issue templates and directions for filing in correct repo #12710
Conversation
SUPPORT.md
Outdated
|
|
||
| 1. Consider using [Google Cloud Customer Care](https://cloud.google.com/support/?hl=en) (paid) to get more dedicated support for your issue. Otherwise, continue with the steps below. | ||
| 2. Find your API in [the client list at the top of this repository](https://github.com/googleapis/google-cloud-python/tree/main?tab=readme-ov-file#libraries). | ||
| 3. Check the “Issue Tracker” column to see whether someone else has reported the same issue. If they have, the filed issue may have some useful information; feel free to add more details or context of your own. |
There was a problem hiding this comment.
Should we add a note that folks can file API issues in the corresponding client library repository in the case where there is no API specific issue tracker?
vchudnov-g
force-pushed
the
issue-templates
branch
6 times, most recently
from
d2b4192 to
0d8076f
Compare
vchudnov-g
added
the
do not merge
|
Adding |
| - type: input | ||
| attributes: | ||
| label: API client name and version | ||
| description: Try `pip list | grep google-cloud`, which should give you a name corresponding to one of the packages listed [here](https://github.com/googleapis/google-cloud-python/tree/main/packages). |
There was a problem hiding this comment.
| description: Try `pip list | grep google-cloud`, which should give you a name corresponding to one of the packages listed [here](https://github.com/googleapis/google-cloud-python/tree/main/packages). | |
| description: Try `pip list | grep google`, which should give you a name corresponding to one of the packages listed [here](https://github.com/googleapis/google-cloud-python/tree/main/packages). |
There was a problem hiding this comment.
Good idea. Did it with a trailing hyphen. WDYT?
There was a problem hiding this comment.
It may be helpful without the trailing hyphen as an additional package googleapis-common-protos will be included
There was a problem hiding this comment.
OK, good catch! Will do.
SUPPORT.md
Outdated
| # Check for already opened issues: | ||
|
|
||
| - In `google-cloud-python`: <https://github.com/googleapis/google-cloud-python/issues> | ||
| - In Stack Overflow: <https://stackoverflow.com/questions/tagged/google-cloud-platform+python> |
There was a problem hiding this comment.
Do we want to list Stack Overflow here? Does it belong in the bug intake process?
There was a problem hiding this comment.
I was basing this off of what NodeJS is doing: https://github.com/googleapis/google-cloud-node/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml
We can take it out, though I think there could be value in pointing people to "easy" places to search for issues. WDYT?
There was a problem hiding this comment.
I'm concerned that users won't report issue in Github if they're already in Stack Overflow. As an example, see #12749 (comment) which mentions that an issue was reported on Stack Overflow a month ago and only reported in this repository in the last week. If Stack Overflow is not part of our bug intake, then we shouldn't mention it here.
There was a problem hiding this comment.
Hmm, I see your point. The purpose was to help users help themselves more quickly, but you're right, it does run the risk that even if the community finds a workaround, we won't hear about it to incorporate it or fix the code because no formal issues are filed. OK, I'll take it out, though I do think some reference to searching on SO might be good. But we have to determine the right phrasing.
There was a problem hiding this comment.
Looking at the python-api-common-protos bug template, they say this: maybe we should incorporate it? WDYT, @parthea ?
Please run down the following list and make sure you've tried the usual "quick fixes":
- Search the issues already opened: https://github.com/googleapis/python-api-common-protos/issues
- Search StackOverflow: https://stackoverflow.com/questions/tagged/google-cloud-platform+python
If you are still having issues, please be sure to include as much information as possible:
There was a problem hiding this comment.
This wording sounds good to me. We should encourage users to open issues for bugs, even if there are workarounds/quick fixes. It would be good to incorporate that as well.
There was a problem hiding this comment.
OK, I'm submitting without the SO reference, and we can wordsmith that in via a chaser PR.
This file will be referenced by issue templates.
vchudnov-g
force-pushed
the
issue-templates
branch
from
1820499 to
668cba0
Compare
vchudnov-g
removed
the
do not merge
vchudnov-g
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
Fixes #12651
TAL @ the main branch on my fork to preview the experience.
TODODONE: When this has been approved, and prior to merging, I'll update all links to refer to the main (upstream) repo and not my fork.