How to Contribute

All contributors are expected to follow the Code of Conduct.

Reporting Issues and Making Feature Requests

Please file issues, questions, and feature requests on the GitHub issue tracker: https://github.com/adbc-drivers/driverbase-go/issues

Potential security vulnerabilities should be reported to security@adbc-drivers.org instead. See the Security Policy.

You will need the latest release of Go.

You can build and run tests using the standard Go commands from one of the project subdirectories (driverbase/, testutil/, or validation/):

go build ./...
go test ./...

Code style, linting, and other static checks are enforced via pre-commit. Install pre-commit, then check your code:

pre-commit run --all-files

Before opening a pull request:

Review your changes and make sure no stray files, etc. are included.
Ensure the Apache license header is at the top of all files.
Check if there is an existing issue. If not, please file one, unless the change is trivial.
Assign the issue to yourself by commenting just the word take.
Run the static checks by installing pre-commit, then running pre-commit run --all-files from inside the repository. Make sure all your changes are staged/committed (unstaged changes will be ignored).

When writing the pull request description:

Commit messages will be ignored. We squash-merge all pull requests.
Ensure the title follows Conventional Commits format. The component should be either driverbase, testutil, or validation (in general: it should be a directory path relative to the repo root, e.g. driverbase/arrowext is also valid). Example titles:
- feat(driverbase): implement record reader framework
- chore(testutil): update stretchr/testify dependency
- refactor(driverbase)!: manage statement state internally
Ensure that breaking changes are appropriately flagged with a ! as seen above.
Make sure the bottom of the description has Closes #NNN, Fixes #NNN, or similar, so that the issue will be linked to your pull request.