Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.46 KB

contributing-guide.md

File metadata and controls

95 lines (67 loc) · 3.46 KB

Contributing guide

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

All contributors and maintainers to this project should abide by the Contributor Code of Conduct.

Learn more about the contributors' roles in the Roles page.

This document describes how to contribute to the Great Expectations Airflow Provider, covering:

  • Overview of how to contribute
  • How to set up the local development environment
  • Running tests
  • Authoring the documentation

Overview of how to contribute

To contribute to the Great Expectations Airflow Provider project:

  1. Create a GitHub Issue describing a bug, enhancement, or feature request.
  2. Fork the repository.
  3. In your fork, open a branch off of the main branch.
  4. Create a Pull Request into the main branch of the Provider repo from your forked feature branch.
  5. Link your issue to the Pull Request.
  6. After you complete development on your feature branch, request a review. A maintainer will merge your PR after all reviewers approve it.

Set up a local development environment

Setting up a local development environment involves fulfilling requirements, getting a copy of the repository, and setting up a virtual environment.

Requirements

Get a copy of the repository

  1. Fork the Provider repository.

  2. Clone your fork.

    git clone https://github.com/my-user/airflow-provider-great-expectations.git

Set up a virtual environment

You can use any virtual environment tool. The following example uses the venv tool included in the Python standard library.

  1. Create the virtual environment.

    $ python -m venv .venv

  2. Activate the virtual environment.

    $ . .venv/bin/activate

  3. Install the package and testing dependencies.

    (.venv) $ pip install -e '.[tests]'

Run tests

Test with pytest:

  1. Install pytest as a dependency. 
    pip install "airflow-provider-great-expectations[tests]"
  2. Run the following command, which will provide a concise output when all tests pass and minimum necessary details when they don't. 
    pytest -p no:warnings
    The no:warnings flag filters out deprecation messages that may be issued by Airflow.

Write docs

We use Markdown to author Great Expectations Airflow Provider documentation. We use hatch to build and release the docs.

  1. Update Markdown files in the docs/ folder.
  2. Build and serve the documentation locally to preview your changes. 
    hatch run docs:dev
  3. Open an issue and PR for your changes.
  4. Once approved, release the documentation with the current project version and set it to the latest. 
    hatch run docs:gh-release