Contributing code

🧱 Component Reference

To understand how the below components interact with each other, refer to Understand the lifecycle of a workflow.

flyte

Repo	flyte
Purpose	Deployment, Documentation, and Issues
Languages	RST

flyteidl

Repo	flyteidl
Purpose	Flyte workflow specification is in protocol buffers which forms the core of Flyte
Language	Protobuf
Guidelines	Refer to the README

flytepropeller

Repo	flytepropeller | Code Reference
Purpose	Kubernetes-native operator
Language	Go
Guidelines
	- Check for Makefile in the root repo
	- Run the following commands:
	- make generate
	- make test_unit
	- make lint
	- To compile, run make compile

flyteadmin

Repo	flyteadmin | Code Reference
Purpose	Control Plane
Language	Go
Guidelines
	- Check for Makefile in the root repo
	- If the service code has to be tested, run it locally:
	- make compile
	- make server
	- To seed data locally:
	- make compile
	- make seed_projects
	- make migrate
	- To run integration tests locally:
	- make integration
	- (or to run in containerized dockernetes): make k8s_integration

flytekit

Repo	flytekit
Purpose	Python SDK & Tools
Language	Python
Guidelines	Refer to the Flytekit Contribution Guide

flyteconsole

Repo	flyteconsole
Purpose	Admin Console
Language	Typescript
Guidelines	Refer to the README

datacatalog

Repo	datacatalog | Code Reference
Purpose	Manage Input & Output Artifacts
Language	Go

flyteplugins

Repo	flyteplugins | Code Reference
Purpose	Flyte Plugins
Language	Go
Guidelines
	- Check for Makefile in the root repo
	- Run the following commands:
	- make generate
	- make test_unit
	- make lint

flytestdlib

Repo	flytestdlib
Purpose	Standard Library for Shared Components
Language	Go

flytectl

Repo	flytectl
Purpose	A standalone Flyte CLI
Language	Go
Guidelines	Refer to the FlyteCTL Contribution Guide