-
Notifications
You must be signed in to change notification settings - Fork 604
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: update feature request, process, and docs templates (#5410)
* chore: update FR template * chore: add documentation and process request templates * fix template
- Loading branch information
Showing
4 changed files
with
110 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
name: Documentation Requests | ||
description: Requests for more information | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
Please use this issue type to log documentation requests against the library itself. | ||
These requests should involve documentation on Github, and should relate to the library | ||
itself, not to any APIs. If you have questions or documentation requests for an API, please | ||
reach out to the API tracker itself. | ||
Please submit an issue to the API team, either by submitting an | ||
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers), or by | ||
submitting an issue in its linked tracker in the .repo-metadata.json | ||
file in the API under packages/* ([example](https://github.com/googleapis/google-cloud-node/blob/58419684469e3900146c8e830543bf4dc0cbb2be/packages/google-cloud-batch/.repo-metadata.json#L6)). | ||
You can also submit a request to documentation on cloud.google.com itself with the "Send Feedback" | ||
on the bottom of the page. | ||
Please note that documentation requests and questions for specific APIs | ||
will be closed. | ||
- type: checkboxes | ||
attributes: | ||
label: Please make sure you have searched for information in the following | ||
guides. | ||
options: | ||
- label: "Search the issues already opened: | ||
https://github.com/GoogleCloudPlatform/google-cloud-node/issues" | ||
required: true | ||
- label: "Check our Troubleshooting guide: | ||
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\ | ||
es/troubleshooting" | ||
required: true | ||
- label: "Check our FAQ: | ||
https://googlecloudplatform.github.io/google-cloud-node/#/docs/guid\ | ||
es/faq" | ||
required: true | ||
- label: "Check our libraries HOW-TO: | ||
https://github.com/googleapis/gax-nodejs/blob/main/client-libraries\ | ||
.md" | ||
required: true | ||
- label: "Check out our authentication guide: | ||
https://github.com/googleapis/google-auth-library-nodejs" | ||
required: true | ||
- label: "Check out handwritten samples for many of our APIs: | ||
https://github.com/GoogleCloudPlatform/nodejs-docs-samples" | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: > | ||
Documentation Request | ||
validations: | ||
required: true |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
name: Feature Request | ||
description: Suggest an idea for this library | ||
labels: | ||
- feature request | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: > | ||
**PLEASE READ**: If you have a support contract with Google, please | ||
create an issue in the [support | ||
console](https://cloud.google.com/support/) instead of filing on GitHub. | ||
This will ensure a timely response. Otherwise, please make sure to | ||
follow the steps below. | ||
- type: textarea | ||
attributes: | ||
label: > | ||
A screenshot that you have tested with "Try this API". | ||
description: > | ||
As our client libraries are mostly autogenerated, we kindly request | ||
that you test whether your feature request is with the client library, or with the | ||
API itself. To do so, please search for your API | ||
here: https://developers.google.com/apis-explorer and attempt to | ||
reproduce the issue in the given method. Please include a screenshot of | ||
the response in "Try this API". This response should NOT match the current | ||
behavior you are experiencing. If the behavior is the same, it means | ||
that you are likely requesting a feature for the API itself. In that | ||
case, please submit an issue to the API team, either by submitting an | ||
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers), or by | ||
submitting an issue in its linked tracker in the .repo-metadata.json | ||
file in the API under packages/* ([example](https://github.com/googleapis/google-cloud-node/blob/58419684469e3900146c8e830543bf4dc0cbb2be/packages/google-cloud-batch/.repo-metadata.json#L6)) | ||
Examples of common library-specific issues vs. API issues are: retry strategies, authentication questions, issues with typings. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: > | ||
What would you like to see in the library? | ||
description: > | ||
Screenshots can be provided in the issue body below. | ||
placeholder: | | ||
1. Set up authentication like so | ||
2. Run the program like so | ||
3. X would be nice to happen | ||
- type: textarea | ||
attributes: | ||
label: Describe alternatives you've considered | ||
|
||
- type: textarea | ||
attributes: | ||
label: Additional context/notes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
name: Process Request | ||
about: Submit a process request to the library. Process requests are any requests related to library infrastructure, including CI/CD, publishing, releasing, etc. This issue template should primarily used by internal members. | ||
|
||
--- |