All contributors are expected to follow the Code of Conduct.
Please file issues, questions, and feature requests on the GitHub issue tracker: https://github.com/adbc-drivers/dev/issues
Potential security vulnerabilities should be reported to security@adbc-drivers.org instead. See the Security Policy.
- Install Python.
- Create a virtual environment, if needed.
- Install the project:
pip install --editable ..
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-filesfrom 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. No component is necessary. Example titles:
feat: add changelog generatorfix: correct typo in actionchore: update setup-pixi actionfix!: update commit format
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.