Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (56 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

76 lines (56 loc) · 2.75 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/singlestore/issues

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

Build and Test

Most likely, you want to contribute to the upstream driver at https://github.com/singlestore-labs/singlestore-adbc-connector. This repository only holds build and test scripts for the ADBC Driver Foundry.

You can invoke the build script used by CI:

$ cd src/
# ./ci/scripts/build.sh <test|release> <linux|macos|windows> <amd64|arm64>
# For example, this makes a debug build:
$ ./ci/scripts/build.sh test linux amd64

This will produce a shared library in src/build.

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 generally be omitted. Example titles:

    • feat: support GEOGRAPHY data type
    • chore: update action versions
    • fix!: 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.