Skip to content

Commit 8f73a79

Browse files
gRedHeadphonegRedHeadphone
committed
chore: Issue & PR Template + configuration files + CODEOWNERS
1 parent 00558e3 commit 8f73a79

10 files changed

+330
-14
lines changed

‎.github/CODEOWNERS

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# This file controls who is tagged for review for any given pull request.
2+
#
3+
# For syntax help see:
4+
# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
5+
6+
* @googleapis/senseai-eco @googleapis/llama-index-spanner

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,27 @@ about: Create a report to help us improve
44

55
---
66

7-
## Expected Behavior
7+
Thanks for stopping by to let us know something could be better!
88

9+
**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.
910

10-
## Actual Behavior
11+
Please run down the following list and make sure you've tried the usual "quick fixes":
1112

13+
- Search the issues already opened: https://github.com/googleapis/llama-index-spanner-python/issues
1214

13-
## Steps to Reproduce the Problem
15+
If you are still having issues, please be sure to include as much information as possible:
1416

15-
1.
16-
1.
17-
1.
17+
#### Environment details
1818

19-
## Specifications
19+
- OS:
20+
- Language version:
21+
- Package/Project management version:
2022

21-
- Version:
22-
- Platform:
23+
#### Steps to reproduce
24+
25+
1. ?
26+
2. ?
27+
28+
Making sure to follow these steps will guarantee the quickest resolution possible.
29+
30+
Thanks!

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this library
4+
5+
---
6+
7+
Thanks for stopping by to let us know something could be better!
8+
9+
**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.
10+
11+
**Is your feature request related to a problem? Please describe.**
12+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
**Additional context**
18+
Add any other context or screenshots about the feature request here.

‎.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 create an issue in the Google Cloud Support console.
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 & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
Fixes #<issue_number_goes_here>
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 before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
3+
- [ ] Follow the [Samples Style Guide](https://googlecloudplatform.github.io/samples-style-guide/)
4+
- [ ] Ensure the tests and linter pass
5+
- [ ] Communicate test infrastructure changes, i.e. API enablement, secrets
6+
- [ ] Appropriate docs were updated (if necessary)
27

3-
> It's a good idea to open an issue first for discussion.
4-
5-
- [ ] Tests pass
6-
- [ ] Appropriate changes to documentation are included in the PR
8+
🛠️ Fixes #<issue_number_goes_here>

‎.github/header-checker-lint.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Copyright 2024 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+
15+
16+
# Presubmit test that ensures that source files contain valid license headers
17+
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/header-checker-lint
18+
# Install: https://github.com/apps/license-header-lint-gcf
19+
20+
allowedCopyrightHolders:
21+
- 'Google LLC'
22+
allowedLicenses:
23+
- 'Apache-2.0'
24+
sourceFileExtensions:
25+
- 'yaml'
26+
- 'yml'
27+
- 'sh'
28+
- 'ts'
29+
- 'js'
30+
- 'java'
31+
- 'py'
32+
- 'html'
33+
- 'txt'
34+
- 'Dockerfile'
35+
- 'go'
36+
- 'tf'
37+
- 'proto'

‎.github/renovate.json5

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
// Copyright 2024 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+
15+
16+
// Dependency Update Configuration
17+
//
18+
// See https://docs.renovatebot.com/configuration-options/
19+
// See https://json5.org/ for JSON5 syntax
20+
{
21+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
22+
"extends": [
23+
"config:base", // https://docs.renovatebot.com/presets-config/#configbase
24+
":semanticCommits", // https://docs.renovatebot.com/presets-default/#semanticcommits
25+
":ignoreUnstable", // https://docs.renovatebot.com/presets-default/#ignoreunstable
26+
"group:allNonMajor", // https://docs.renovatebot.com/presets-group/#groupallnonmajor
27+
":separateMajorReleases", // https://docs.renovatebot.com/presets-default/#separatemajorreleases
28+
":prConcurrentLimitNone", // View complete backlog as PRs. https://docs.renovatebot.com/presets-default/#prconcurrentlimitnone
29+
":prNotPending", // https://docs.renovatebot.com/presets-default/#prnotpending
30+
":prHourlyLimitNone", // https://docs.renovatebot.com/presets-default/#prhourlylimitnone
31+
"docker:enableMajor", // https://docs.renovatebot.com/presets-docker/#dockerenablemajor
32+
],
33+
34+
// Synchronized with a 2 week sprint cycle and outside business hours.
35+
// https://docs.renovatebot.com/configuration-options/#schedule
36+
"schedule": ["every 2 weeks on Saturday"],
37+
38+
// Give ecosystem time to catch up.
39+
// npm allows maintainers to unpublish a release up to 3 days later.
40+
// https://docs.renovatebot.com/configuration-options/#minimumreleaseage
41+
"minimumReleaseAge": "3",
42+
43+
// Create PRs, but do not update them without manual action.
44+
// Reduces spurious retesting in repositories that have many PRs at a time.
45+
// https://docs.renovatebot.com/configuration-options/#rebasewhen
46+
"rebaseWhen": "never",
47+
48+
// Organizational processes.
49+
// https://docs.renovatebot.com/configuration-options/#dependencydashboardlabels
50+
"dependencyDashboardLabels": [
51+
"type: process",
52+
],
53+
// https://docs.renovatebot.com/configuration-options/#prbodynotes
54+
"prBodyNotes": [
55+
"Reviewer is responsible for dependency update. Ensure adequate automated or manual testing is performed before merge.",
56+
],
57+
58+
"packageRules": [
59+
// Report impact of a dependency update via PR label.
60+
{
61+
"matchUpdateTypes": ["patch"],
62+
"addLabels": ["semver: patch"],
63+
},
64+
{
65+
"matchUpdateTypes": ["minor"],
66+
"addLabels": ["semver: minor"],
67+
},
68+
{
69+
"matchUpdateTypes": ["major"],
70+
"addLabels": ["semver: major"],
71+
},
72+
73+
// Language-specific behaviors.
74+
{
75+
"matchLanguages": ["go"],
76+
"postUpdateOptions": ["gomodTidy"],
77+
},
78+
79+
// Tooling & Runtime behaviors.
80+
{
81+
// Covers Dockerfiles, cloudbuild.yaml, and other docker-based tools.
82+
"groupName": "Docker Runtimes",
83+
"matchDatasources": ["docker"],
84+
// TODO: Uncomment if your Dockerfiles are not included in samples.
85+
// Increases build repeatability, image cache use, and supply chain security.
86+
// "pinDigests": true,
87+
},
88+
{
89+
"groupName": "GitHub Actions",
90+
"matchManagers": ["github-actions"],
91+
"pinDigests": true,
92+
},
93+
94+
// Language groupings.
95+
// These are separated to facilitate PR review by single-language experts.
96+
{
97+
"groupName": "go-nonmajor",
98+
"matchLanguages": ["go"],
99+
"matchUpdateTypes": ["minor", "patch"],
100+
},
101+
{
102+
"groupName": "python-nonmajor",
103+
"matchLanguages": ["python"],
104+
"matchUpdateTypes": ["minor", "patch"],
105+
},
106+
{
107+
"groupName": "java-nonmajor",
108+
"matchLanguages": ["java"],
109+
"matchUpdateTypes": ["minor", "patch"],
110+
},
111+
{
112+
"groupName": "js-nonmajor",
113+
"matchLanguages": ["js"],
114+
"matchUpdateTypes": ["minor", "patch"],
115+
},
116+
{
117+
"groupName": "nodejs-nonmajor",
118+
"matchLanguages": ["node"],
119+
"matchUpdateTypes": ["minor", "patch"],
120+
},
121+
{
122+
"groupName": "npm-dev",
123+
"matchManagers": ["npm"],
124+
"matchDepTypes": ["devDependencies"],
125+
"separateMajorMinor": false,
126+
},
127+
{
128+
"groupName": "Terraform",
129+
"matchManagers": ["terraform"],
130+
"separateMajorMinor": false,
131+
},
132+
133+
// Updating coupled ecosystems.
134+
{
135+
"groupName": "Playwright",
136+
"matchPackageNames": [
137+
"playwright",
138+
"@playwright/test",
139+
"mcr.microsoft.com/playwright",
140+
],
141+
},
142+
{
143+
"groupName": "OpenTelemetry",
144+
"matchLanguages": ["python"],
145+
"matchPackagePrefixes": ["opentelemetry-"],
146+
},
147+
],
148+
}

‎.github/snippet-bot.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Copyright 2024 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+
15+
16+
# Presubmit test to check for mismatched region tags in PRs
17+
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/snippet-bot
18+
# Install: https://github.com/apps/snippet-bot

‎.github/sync-repo-settings.yaml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Copyright 2024 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+
15+
16+
# Synchronize repository settings from a centralized config
17+
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/sync-repo-settings
18+
# Install: https://github.com/apps/sync-repo-settings
19+
20+
# Disable merge commits
21+
rebaseMergeAllowed: true
22+
squashMergeAllowed: true
23+
mergeCommitAllowed: false
24+
# Enable branch protection
25+
branchProtectionRules:
26+
- pattern: main
27+
isAdminEnforced: true
28+
requiredStatusCheckContexts:
29+
- 'cla/google'
30+
# - Add required status checks like presubmit tests
31+
requiredApprovingReviewCount: 1
32+
requiresCodeOwnerReviews: true
33+
requiresStrictStatusChecks: true
34+
35+
# Set team access
36+
permissionRules:
37+
- team: senseai-eco
38+
permission: admin
39+
- team: llama-index-spanner
40+
permission: push

‎.github/trusted-contribution.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Copyright 2024 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+
15+
16+
# Trigger presubmit tests for trusted contributors
17+
# https://github.com/googleapis/repo-automation-bots/tree/main/packages/trusted-contribution
18+
# Install: https://github.com/apps/trusted-contributions-gcf
19+
20+
trustedContributors:
21+
- "dependabot[bot]"
22+
- "renovate-bot"
23+
- "renovate[bot]"
24+
- "forking-renovate[bot]"
25+
- "release-please[bot]"
26+
annotations:
27+
# Trigger Cloud Build tests
28+
- type: comment
29+
text: "/gcbrun"
30+
# Trigger Kokoro example
31+
# - type: label
32+
# text: "kokoro:force-run"

0 commit comments

Comments
 (0)