fix: update node issue template#582
Conversation
googlebot
added
the
cla: yes
JustinBeckwith
left a comment
JustinBeckwith
left a comment
There was a problem hiding this comment.
We have a fair bit of evidence that folks entirely ignore these templates, but it doesn't hurt to try!
|
|
||
| Please run down the following list and make sure you've tried the usual "quick fixes": | ||
| 1) Is this a client library issue or a product issue? | ||
| This is the client library for {{metadata['product']}}. We will only be able to assist with issues that pertain to the behaviors of this library. If the issue you're experiencing is due to the behavior of the product itself, please visit [{{metadata['product']}} Support page]({{metadata['product-url']}}/docs/getting-support) to reach the most relevant engineers. |
There was a problem hiding this comment.
Haha, you can see what's available here:
https://github.com/googleapis/google-cloud-node/blob/master/libraries.json
You probably want:
product=>name_prettyproduct-url=>product_documentation
In some cases we also have a link to the product issue tracker via issue_tracker. I would double check that value is available on a library by library basis before using it though.
There was a problem hiding this comment.
Ah, nice. I sent a PR (that this PR now depends on): googleapis/google-cloud-node#3008
|
@JustinBeckwith googleapis/google-cloud-node#3008 merged which added a new property "support_documentation" to libraries.json. This PR was updated with your feedback and to make use of that new property. PTAL! |
|
P.S. I have no merge rights here :) |
|
@JustinBeckwith Uh oh! The placeholders aren't replaced: https://github.com/googleapis/nodejs-datastore/issues/new?template=bug_report.md and |
|
wibble |
|
I kind of figured you had tested this locally with synthtool 🐸 Mind working through the instructions here to get it running locally: If you need help figuring out what's up, @bcoe is probably your best bet :) |
|
Thanks, I have made a discovery while testing with Storage... the placeholders are from the For now, should we just roll this PR back? Figure out how to sync |
|
@bcoe how do you think we should proceed? Where we are now:
How we got here:
Where we can go:
|
3 participants
We frequently see issues where users are having a problem with the product as opposed to the client library itself. We end up wasting their time before coming to the conclusion "it's not us, it's them". I've updated the messaging in the issue template to promote self-diagnostics in the hope the user ultimately asks the right team only once.