Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (78 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

112 lines (78 loc) · 3.26 KB

How to Contribute

All contributors are expected to follow the Code of Conduct.

Reporting Issues and Making Feature Requests

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

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

Build and Test

C#

For basic development, the driver can be built and tested like any .NET project. From the csharp/ subdirectory:

$ dotnet build
$ dotnet test

Go

Pre-requisites

Building

From the ./go directory, run:

pixi run make

This builds the driver as a shared library in ./build.

Testing

To run the unit tests:

pixi run test

To run the full suite of tests, you will need a Databricks instance to test against and the following environment variables set:

  • DATABRICKS_HOST
  • DATABRICKS_ACCESSTOKEN
  • DATABRICKS_HTTPPATH

To run the validation suite:

pixi run validate

Note: The validate subcommand requires the same environment variables as test.

Opening a Pull Request

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:

  • Ensure the title follows Conventional Commits format. The component should be csharp if it affects the C# driver, or it can be omitted for general maintenance (in general: it should be a directory path relative to the repo root, e.g. csharp/auth would also be valid if that directory existed). Example titles:

    • feat(csharp): support GEOGRAPHY data type
    • chore: update action versions
    • fix!(csharp): return us instead of ms

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

  • Make sure the description ends with Closes #NNN, Fixes #NNN, or similar, so that the issue will be linked to your pull request.