Contributors¶
Guides for contributing to the Lakeflow Framework — environment setup, workflow, git conventions, import rules, and documentation.
Browse the guides below. For community integrations, see Contributing to lakeflow_framework.contrib in the sidebar.
Set up your environment
Clone the repo, install dev dependencies from lockfiles, and configure VS Code for framework development.
Open guideBranching, versioning & releases
Trunk-based git, branch naming, manual VERSION bumps, and release conventions — read before opening a pull request.
Open guideContribution workflow
Issue, branch, test, document, pull request, and post-merge verification.
Open guideImport conventions
lakeflow_framework.* canonical imports, compat shims, and rules for tests, scripts, and samples.
Write & build docs
reStructuredText source, Sphinx build, lockfiles, styling, and adding feature documentation.
Open guide