Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 2.44 KB

File metadata and controls

65 lines (48 loc) · 2.44 KB

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/dev/issues

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

Setting Up a Developer Environment

  1. Install Python.
  2. Create a virtual environment, if needed.
  3. Install the project: pip install --editable ..

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. No component is necessary. Example titles:

    • feat: add changelog generator
    • fix: correct typo in action
    • chore: update setup-pixi action
    • fix!: 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.