Skip to content

Commit 97d85ea

Browse files
miguelvelezsamiguelvelezsa
authored
Merge pull request #2 from googleapis/github-configuration
chore: add github configuration/ci files
2 parents 8c78d99 + d36a135 commit 97d85ea

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+1608
-0
lines changed

‎.github/.OwlBot.lock.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
docker:
15+
image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs-mono-repo:latest
16+
digest: sha256:e8e6990de55638a07539109d3148e5a88fbedfee2d28742bad8c0f8fb2fbfafe

‎.github/.OwlBot.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Copyright 2022 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
docker:
15+
image: gcr.io/cloud-devrel-public-resources/owlbot-nodejs-mono-repo:latest

‎.github/CODEOWNERS‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Code owners file.
2+
# This file controls who is tagged for review for any given pull request.
3+
#
4+
# For syntax help see:
5+
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
6+
7+
8+
# The yoshi-nodejs team is the default owner for nodejs repositories.
9+
* @googleapis/jsteam @yoshi-approver

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Bug Report
2+
description: Create a report to help us improve
3+
labels:
4+
- bug
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**PLEASE READ**: If you have a support contract with Google, please
10+
create an issue in the [support
11+
console](https://cloud.google.com/support/) instead of filing on GitHub.
12+
This will ensure a timely response. Otherwise, please make sure to
13+
follow the steps below.
14+
- type: checkboxes
15+
attributes:
16+
label: Please make sure you have searched for information in the following
17+
guides.
18+
options:
19+
- label: "Search the issues already opened:
20+
https://github.com/googleapis/google-cloud-node-core/issues"
21+
required: true
22+
- label: "Search StackOverflow:
23+
http://stackoverflow.com/questions/tagged/google-cloud-platform+nod\
24+
e.js"
25+
required: true
26+
- label: "Check our Troubleshooting guide:
27+
https://github.com/googleapis/google-cloud-node-core/blob/main/docs/trou\
28+
bleshooting.md"
29+
required: true
30+
- label: "Check our FAQ:
31+
https://github.com/googleapis/google-cloud-node-core/blob/main/docs/faq.\
32+
md"
33+
required: true
34+
- label: "Check our libraries HOW-TO:
35+
https://github.com/googleapis/gax-nodejs/blob/main/client-libraries\
36+
.md"
37+
required: true
38+
- label: "Check out our authentication guide:
39+
https://github.com/googleapis/google-auth-library-nodejs"
40+
required: true
41+
- label: "Check out handwritten samples for many of our APIs:
42+
https://github.com/GoogleCloudPlatform/nodejs-docs-samples"
43+
required: true
44+
- label: "Check the API's issue tracker:
45+
https://cloud.google.com/support/docs/issue-trackers"
46+
required: true
47+
- type: input
48+
attributes:
49+
label: >
50+
Link to the code that reproduces this issue. A link to a **public** Github Repository or gist with a minimal
51+
reproduction.
52+
description: >
53+
**Skipping this or providing an invalid link will result in the issue being closed**
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: >
59+
A step-by-step description of how to reproduce the issue, based on
60+
the linked reproduction.
61+
description: >
62+
Screenshots can be provided in the issue body below.
63+
placeholder: |
64+
1. Start the application in development (next dev)
65+
2. Click X
66+
3. Y will happen
67+
validations:
68+
required: true
69+
- type: textarea
70+
attributes:
71+
label: A clear and concise description of what the bug is, and what you
72+
expected to happen.
73+
placeholder: Following the steps from the previous section, I expected A to
74+
happen, but I observed B instead
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
attributes:
80+
label: A clear and concise description WHY you expect this behavior, i.e., was it a recent change, there is documentation that points to this behavior, etc. **
81+
placeholder: 'Documentation here(link) states that B should happen instead of A'
82+
validations:
83+
required: true

‎.github/ISSUE_TEMPLATE/documentation_request.yaml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Documentation Requests
2+
description: Requests for more information
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: >
7+
Please use this issue type to log documentation requests against the library itself.
8+
These requests should involve documentation on Github (`.md` files), and should relate to the library
9+
itself, not to any APIs. If you have questions or documentation requests for an API, please
10+
reach out to the API tracker itself.
11+
12+
Please submit an issue to the API team, either by submitting an
13+
issue in its issue tracker https://cloud.google.com/support/docs/issue-trackers), or by
14+
submitting an issue in its linked tracker in the .repo-metadata.json
15+
file in the API under packages/* ([example](https://github.com/googleapis/google-cloud-node/blob/58419684469e3900146c8e830543bf4dc0cbb2be/packages/google-cloud-batch/.repo-metadata.json#L6)).
16+
You can also submit a request to documentation on cloud.google.com itself with the "Send Feedback"
17+
on the bottom of the page.
18+
19+
20+
Please note that documentation requests and questions for specific APIs
21+
will be closed.
22+
- type: checkboxes
23+
attributes:
24+
label: Please make sure you have searched for information in the following
25+
guides.
26+
options:
27+
- label: "Search the issues already opened:
28+
https://github.com/googleapis/google-cloud-node-core/issues"
29+
required: true
30+
- label: "Check our Troubleshooting guide:
31+
https://github.com/googleapis/google-cloud-node-core/blob/main/docs/troubleshooting.md"
32+
required: true
33+
- label: "Check our FAQ:
34+
https://github.com/googleapis/google-cloud-node-core/blob/main/docs/faq.md"
35+
required: true
36+
- label: "Check our libraries HOW-TO:
37+
https://github.com/googleapis/gax-nodejs/blob/main/client-libraries\
38+
.md"
39+
required: true
40+
- label: "Check out our authentication guide:
41+
https://github.com/googleapis/google-auth-library-nodejs"
42+
required: true
43+
- label: "Check out handwritten samples for many of our APIs:
44+
https://github.com/GoogleCloudPlatform/nodejs-docs-samples"
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: >
49+
Documentation Request
50+
validations:
51+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yaml‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Feature Request
2+
description: Suggest an idea for this library
3+
labels:
4+
- feature request
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**PLEASE READ**: If you have a support contract with Google, please
10+
create an issue in the [support
11+
console](https://cloud.google.com/support/) instead of filing on GitHub.
12+
This will ensure a timely response. Otherwise, please make sure to
13+
follow the steps below.
14+
- type: textarea
15+
attributes:
16+
label: >
17+
What would you like to see in the library?
18+
description: >
19+
Screenshots can be provided in the issue body below.
20+
placeholder: |
21+
1. Set up authentication like so
22+
2. Run the program like so
23+
3. X would be nice to happen
24+
25+
- type: textarea
26+
attributes:
27+
label: Describe alternatives you've considered
28+
29+
- type: textarea
30+
attributes:
31+
label: Additional context/notes

‎.github/ISSUE_TEMPLATE/process_request.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: Process Request
3+
about: Submit a process request to the library. Process requests are any requests related to library infrastructure, including CI/CD, publishing, releasing, broken links.
4+
5+
---

‎.github/ISSUE_TEMPLATE/questions.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
name: Question
3+
about: If you have a question, please use Discussions
4+
5+
---
6+
7+
If you have a general question that goes beyond the library itself, we encourage you to use [Discussions](https://github.com/googleapis/google-cloud-node-core/discussions)
8+
to engage with fellow community members!

‎.github/ISSUE_TEMPLATE/support_request.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: Support request
3+
about: If you have a support contract with Google, please use this issue type.
4+
5+
---
6+
7+
**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.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
2+
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/{{metadata['repo']['name']}}/issues) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
3+
- [ ] Ensure the tests and linter pass
4+
- [ ] Code coverage does not decrease (if any source code was changed)
5+
- [ ] Appropriate docs were updated (if necessary)
6+
7+
Fixes #<issue_number_goes_here> 🦕

0 commit comments

Comments
 (0)