Skip to content

Commit 1557538

Browse files
authored
chore: update for repo standards (#1)
1 parent 2c09f0c commit 1557538

6 files changed

Lines changed: 131 additions & 38 deletions

File tree

.github/dependabot.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Copyright (c) 2025 ADBC Drivers Contributors
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+
version: 2
16+
updates:
17+
- package-ecosystem: "github-actions"
18+
commit-message:
19+
prefix: "chore: "
20+
directory: "/"
21+
groups:
22+
actions:
23+
patterns:
24+
- "*"
25+
schedule:
26+
interval: "weekly"
27+
28+
- package-ecosystem: "nuget"
29+
commit-message:
30+
prefix: "chore(csharp): "
31+
directory: "/csharp/"
32+
ignore:
33+
- dependency-name: "Microsoft.Extensions.*"
34+
update-types:
35+
- "version-update:semver-major"
36+
- dependency-name: "Microsoft.Bcl.*"
37+
update-types:
38+
- "version-update:semver-major"
39+
- dependency-name: "System.*"
40+
update-types:
41+
- "version-update:semver-major"
42+
schedule:
43+
interval: "weekly"

.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## What's Changed
2+
3+
Please fill in a description of the changes here.
4+
5+
**This contains breaking changes.** <!-- Remove this line if there are no breaking changes. -->
6+
7+
Closes #NNN.

.pre-commit-config.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Copyright (c) 2025 ADBC Drivers Contributors
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+
repos:
16+
- repo: https://github.com/codespell-project/codespell
17+
rev: 63c8f8312b7559622c0d82815639671ae42132ac # v2.4.1
18+
hooks:
19+
- id: codespell
20+
exclude: >
21+
(?x)^(
22+
.*go\.sum
23+
)$
24+
25+
- repo: https://github.com/pre-commit/pre-commit-hooks
26+
rev: cef0300fd0fc4d2a87a85fa2093c6b283ea36f4b # v5.0.0
27+
hooks:
28+
- id: check-added-large-files
29+
args: ["--enforce-all"]
30+
- id: check-case-conflict
31+
- id: check-executables-have-shebangs
32+
- id: check-yaml
33+
- id: detect-private-key
34+
- id: end-of-file-fixer
35+
exclude: '\.sln$'
36+
- id: mixed-line-ending
37+
args: [--fix=lf]
38+
exclude: '\.(bat|sln)$'
39+
- id: trailing-whitespace
40+
41+
- repo: git@github.com:adbc-drivers/dev
42+
rev: f5779f2109f177f7da6394d3427589a3a84eb521
43+
hooks:
44+
- id: rat

.rat-excludes

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Copyright (c) 2025 ADBC Drivers Contributors
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+
.github/pull_request_template.md
16+
.gitmodules
17+
*.csproj

CONTRIBUTING.md

Lines changed: 12 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Conduct](https://github.com/adbc-drivers/databricks?tab=coc-ov-file#readme).
2222
## Reporting Issues and Making Feature Requests
2323

2424
Please file issues and feature requests on the GitHub issue tracker:
25-
https://github.com/adbc-drivers/google/issues
25+
https://github.com/adbc-drivers/databricks/issues
2626

2727
Potential security vulnerabilities should be reported to
2828
[security@adbc-drivers.org](mailto:security@adbc-drivers.org) instead. See
@@ -31,42 +31,16 @@ the
3131

3232
## Build and Test
3333

34-
### Golang
34+
### C#
3535

36-
For basic development, the driver can be built and tested like any Go project.
37-
From the `go/` subdirectory:
36+
For basic development, the driver can be built and tested like any .NET
37+
project. From the `csharp/` subdirectory:
3838

3939
```shell
40-
$ go build ./...
41-
$ go test -tags assert -v ./...
40+
$ dotnet build
41+
$ dotnet test
4242
```
4343

44-
This will not produce a shared library, however; that requires invoking the
45-
full build script. You will need [pixi](https://pixi.sh/) installed. From
46-
the `go/` subdirectory:
47-
48-
```shell
49-
$ pixi run make
50-
```
51-
52-
To run the validation suite, you will first need to build the shared library.
53-
You will also need to set up a BigQuery instance (see [the validation
54-
README](./validation/README.md)). Finally, from the `go/validation/`
55-
subdirectory:
56-
57-
```shell
58-
$ pixi run test
59-
```
60-
61-
This will produce a test report, which can be rendered into a documentation
62-
page (using MyST Markdown):
63-
64-
```shell
65-
$ pixi run gendocs --output generated/
66-
```
67-
68-
Then look at `./generated/bigquery.md`.
69-
7044
## Opening a Pull Request
7145

7246
Before opening a pull request:
@@ -85,14 +59,14 @@ When writing the pull request description:
8559

8660
- Ensure the title follows [Conventional
8761
Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. The
88-
component should be `go` if it affects the Go driver, or it can be omitted
89-
for general maintenance (in general: it should be a directory path relative
90-
to the repo root, e.g. `go/auth` would also be valid if that directory
91-
existed). Example titles:
62+
component should be `csharp` if it affects the C# driver, or it can be
63+
omitted for general maintenance (in general: it should be a directory path
64+
relative to the repo root, e.g. `csharp/auth` would also be valid if that
65+
directory existed). Example titles:
9266

93-
- `feat(go): support GEOGRAPHY data type`
67+
- `feat(csharp): support GEOGRAPHY data type`
9468
- `chore: update action versions`
95-
- `fix!(go): return us instead of ms`
69+
- `fix!(csharp): return us instead of ms`
9670

9771
Ensure that breaking changes are appropriately flagged with a `!` as seen
9872
in the last example above.

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@
1919
This repository contains [ADBC drivers](https://arrow.apache.org/adbc/) for
2020
Databricks, implemented in different languages.
2121

22+
## Installation
23+
24+
At this time pre-packaged drivers are not yet available.
25+
26+
## Usage
27+
28+
At this time user documentation is not yet available.
29+
2230
## Building
2331

2432
See [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)