contributing.rst

Contributing Guide

All contributions, bug reports, bug fixes, documentation improvements, enhancements are welcome.

As contributors and maintainers to this project, you are expected to abide by the Contributor Code of Conduct.

Overview

To contribute to the Astro Databricks project:

1. Please create a GitHub Issue describing your contribution
2. Open a feature branch off of the main branch and create a Pull Request into the main branch from your feature branch
3. Link your issue to the pull request
4. Once developments are complete on your feature branch, request a review and it will be merged once approved.

Creating a Sandbox to Test Changes

Pre-requisites

• pre-commmit
• nox

Create within tests/ a test-connections.yaml file, similar to :download:`the CI's <../.github/ci-test-connections.yaml>`_.

Run tests

Pre-Commit

We use pre-commit to run a number of checks on the code before committing. To install pre-commit, run the following from your cloned astro-provider-databricks directory:

pre-commit install

To run the checks manually, run:

pre-commit run --all-files

Writing Docs

You can run the docs locally by running the following:

hatch run docs:serve

This will run the docs server in a virtual environment with the right dependencies. Note that it may take longer on the first run as it sets up the virtual environment, but will be quick on subsequent runs.

Building

We use hatch to build the project. To build the project, run:

hatch build

Releasing

We use GitHub actions to create and deploy new releases. To create a new release, first create a new version using:

hatch version minor

hatch will automatically update the version for you. Then, create a new release on GitHub with the new version. The release will be automatically deployed to PyPI.

Note

You can update the version in a few different ways. Check out the hatch docs to learn more.

To validate a release locally, it is possible to build it using:

hatch build

To publish a release to PyPI, use:

hatch publish