Please see Development Guide for project level development instructions.

This guide is targeted at developers looking to contribute to Feast components in the main Feast repository:

• Feast Python SDK / CLI
• Feast Java Serving
• Feast Go Client

Fork the Feast Github repo and clone your fork locally. Then make changes to a local branch to the fork.

See Creating a pull request from a fork

Setup pre-commit to automatically lint and format the codebase on commit:

1. Ensure that you have Python (3.7 and above) with pip, installed.
2. Install pre-commit with pip & install pre-push hooks

pip install pre-commit
pre-commit install --hook-type pre-commit --hook-type pre-push

3. On push, the pre-commit hook will run. This runs make format and make lint.

Use git signoffs to sign your commits. See https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification for details

Then, you can sign off commits with the -s flag:

git commit -s -m "My first commit"

GPG-signing commits with -S is optional.

Our preference is the use of git rebase [master] instead of git merge : git pull -r.

Note that this means if you are midway through working through a PR and rebase, you'll have to force push: git push --force-with-lease origin [branch name]

Setting up your development environment for Feast Python SDK / CLI:

1. Ensure that you have Docker installed in your environment. Docker is used to provision service dependencies during testing.
2. Ensure that you have make, Python (3.7 and above) with pip, installed.
3. Recommended: Create a virtual environment to isolate development dependencies to be installed

# create & activate a virtual environment
python -m venv venv/
source venv/bin/activate

3. Upgrade pip if outdated

pip install --upgrade pip

4. Install development dependencies for Feast Python SDK / CLI

pip install -e "sdk/python[dev]"

Feast Python SDK / CLI codebase:

• Conforms to Black code style
• Has type annotations as enforced by mypy
• Has imports sorted by isort
• Is lintable by flake8

To ensure your Python code conforms to Feast Python code standards:

• Autoformat your code to conform to the code style:

make format-python

• Lint your Python code before submitting it for review:

make lint-python

Setup pre-commit hooks to automatically format and lint on commit.

Unit tests (pytest) for the Feast Python SDK / CLI can run as follows:

make test-python

⚠️ Local configuration can interfere with Unit tests and cause them to fail:

• Ensure no AWS configuration is present and no AWS credentials can be accessed by boto3
• Ensure Feast Python SDK / CLI is not configured with configuration overrides (ie ~/.feast/config should be empty).

To get tests running, you'll need to have GCP / AWS / Redis setup:

Redis

1. Install Redis: Quickstart
2. Run redis-server

GCP

1. Install the Cloud SDK.
2. Then run login to gcloud:

gcloud auth login
gcloud auth application-default login

3. Export GCLOUD_PROJECT=[your project] to your .zshrc

AWS

1. TODO(adchia): flesh out setting up AWS login (or create helper script)
2. Modify RedshiftDataSourceCreator to use your credentials

Then run make test-python-integration. Note that for GCP / AWS, this will create new temporary tables / datasets.

See Java contributing guide

⚠️ Feast Go Client will move to its own standalone repository in the future.

Setting up your development environment for Feast Go SDK:

• Install Golang, protoc with the Golang & grpc plugins

Build the Feast Go Client with the go toolchain:

go build

Feast Go Client codebase:

• Conforms to the code style enforced by go fmt.
• Is lintable by go vet.

Autoformat your Go code to satisfy the Code Style standard:

go fmt

Lint your Go code:

go vet

Setup pre-commit hooks to automatically format and lint on commit.

Unit tests for the Feast Go Client can be run as follows:

go test