LogoLogo
v0.23-branch
masterv0.11-branchv0.12-branchv0.13-branchv0.14-branchv0.15-branchv0.16-branchv0.17-branchv0.18-branchv0.19-branchv0.20-branchv0.21-branchv0.22-branchv0.23-branchv0.24-branchv0.25-branchv0.26-branchv0.27-branchv0.28-branchv0.29-branchv0.30-branchv0.31-branchv0.34-branchv0.35-branchv0.36-branchv0.37-branchv0.38-branchv0.39-branchv0.40-branchv0.41-branchv0.42-branchv0.43-branchv0.45-branchv0.45-branchv0.46-branchv0.47-branchv0.48-branch
v0.23-branch
masterv0.11-branchv0.12-branchv0.13-branchv0.14-branchv0.15-branchv0.16-branchv0.17-branchv0.18-branchv0.19-branchv0.20-branchv0.21-branchv0.22-branchv0.23-branchv0.24-branchv0.25-branchv0.26-branchv0.27-branchv0.28-branchv0.29-branchv0.30-branchv0.31-branchv0.34-branchv0.35-branchv0.36-branchv0.37-branchv0.38-branchv0.39-branchv0.40-branchv0.41-branchv0.42-branchv0.43-branchv0.45-branchv0.45-branchv0.46-branchv0.47-branchv0.48-branch
  • Introduction
  • Community
  • Roadmap
  • Changelog
  • Getting started
    • Quickstart
    • Concepts
      • Overview
      • Data ingestion
      • Entity
      • Feature view
      • Feature retrieval
      • Point-in-time joins
      • Registry
      • [Alpha] Saved dataset
    • Architecture
      • Overview
      • Registry
      • Offline store
      • Online store
      • Batch Materialization Engine
      • Provider
    • Learning by example
    • Third party integrations
    • FAQ
  • Tutorials
    • Sample use-case tutorials
      • Driver ranking
      • Fraud detection on GCP
      • Real-time credit scoring on AWS
      • Driver stats on Snowflake
    • Validating historical features with Great Expectations
    • Using Scalable Registry
    • Building streaming features
  • How-to Guides
    • Running Feast with Snowflake/GCP/AWS
      • Install Feast
      • Create a feature repository
      • Deploy a feature store
      • Build a training dataset
      • Load data into the online store
      • Read features from the online store
    • Running Feast in production
    • Upgrading for Feast 0.20+
    • Customizing Feast
      • Adding a custom batch materialization engine
      • Adding a new offline store
      • Adding a new online store
      • Adding a custom provider
    • Adding or reusing tests
  • Reference
    • Codebase Structure
    • Data sources
      • File
      • Snowflake
      • BigQuery
      • Redshift
      • Push
      • Kafka
      • Kinesis
      • Spark (contrib)
      • PostgreSQL (contrib)
      • Trino (contrib)
    • Offline stores
      • Overview
      • File
      • Snowflake
      • BigQuery
      • Redshift
      • Spark (contrib)
      • PostgreSQL (contrib)
      • Trino (contrib)
    • Online stores
      • SQLite
      • Snowflake
      • Redis
      • Datastore
      • DynamoDB
      • PostgreSQL (contrib)
    • Providers
      • Local
      • Google Cloud Platform
      • Amazon Web Services
    • Feature repository
      • feature_store.yaml
      • .feastignore
    • Feature servers
      • Python feature server
      • [Alpha] Go feature server
      • [Alpha] AWS Lambda feature server
    • [Beta] Web UI
    • [Alpha] On demand feature view
    • [Alpha] Data quality monitoring
    • Feast CLI reference
    • Python API reference
    • Usage
  • Project
    • Contribution process
    • Development guide
      • Maintainer Docs
    • Versioning policy
    • Release process
    • Feast 0.9 vs Feast 0.10+
Powered by GitBook
On this page
  • Overview
  • Making a Pull Request
  • Incorporating upstream changes from master
  • Signing commits
  • Good practices to keep in mind
  • Feast Data Storage Format
  • Feast Protobuf API
  • Generating Language Bindings
  1. Project

Development guide

PreviousContribution processNextMaintainer Docs

Last updated 2 years ago

Overview

This guide is targeted at developers looking to contribute to Feast:

Learn How the Feast works.

Making a Pull Request

See also the CONTRIBUTING.md in the corresponding GitHub repository (e.g. )

Incorporating upstream changes from master

Our preference is the use of git rebase instead of git merge : git pull -r

Signing commits

Commits have to be signed before they are allowed to be merged into the Feast codebase:

# Include -s flag to signoff
git commit -s -m "My first commit"

Good practices to keep in mind

  • Fill in the description based on the default template configured when you first open the PR

    • What this PR does/why we need it

    • Which issue(s) this PR fixes

    • Does this PR introduce a user-facing change

  • Include kind label when opening the PR

  • Add WIP: to PR name if more work needs to be done prior to review

  • Avoid force-pushing as it makes reviewing difficult

Managing CI-test failures

  • GitHub runner tests

    • Click checks tab to analyse failed tests

  • Prow tests

Feast Data Storage Format

Feast data storage contracts are documented in the following locations:

Feast Protobuf API

Feast Protobuf API defines the common API used by Feast's Components:

Generating Language Bindings

The language specific bindings have to be regenerated when changes are made to the Feast Protobuf API:

Repository
Language
Regenerating Language Bindings

Python

Run make compile-protos-python to generate bindings

Golang

Run make compile-protos-go to generate bindings

Visit to analyse failed tests

: Used by BigQuery, Snowflake (Future), Redshift (Future).

: Used by Redis, Google Datastore.

Feast Protobuf API specifications are written in in the Main Feast Repository.

Changes to the API should be proposed via a for discussion first.

Prow status page
Feast Offline Storage Format
Feast Online Storage Format
proto3
GitHub Issue
Maintainer Guide
Contributing Process
main repo doc
Project Structure
Making a Pull Request
Feast Data Storage Format
Feast Protobuf API
Main Feast Repository
Main Feast Repository