Search…
v0.23-branch
Introduction
Community
Roadmap
Changelog
Getting started
Quickstart
Concepts
Architecture
Learning by example
Third party integrations
FAQ
Tutorials
Sample use-case tutorials
Validating historical features with Great Expectations
Using Scalable Registry
Building streaming features
How-to Guides
Running Feast with Snowflake/GCP/AWS
Running Feast in production
Upgrading for Feast 0.20+
Customizing Feast
Adding or reusing tests
Reference
Codebase Structure
Data sources
Offline stores
Online stores
Providers
Feature repository
Feature servers
[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
Development guide

Overview

This guide is targeted at developers looking to contribute to Feast:
Learn How the Feast Contributing Process works.

Making a Pull Request

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

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:
  • Feast Protobuf API specifications are written in proto3 in the Main Feast Repository.
  • Changes to the API should be proposed via a GitHub Issue for discussion first.

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
​Main Feast Repository​
Python
Run make compile-protos-python to generate bindings
​Main Feast Repository​
Golang
Run make compile-protos-go to generate bindings
Project - Previous
Contribution process
Next
Maintainer Docs
Last modified 8d ago
Copy link
Outline
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