Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

76 lines (48 loc) · 2.88 KB

Contributing to the Kubeflow SDK

This guide explains how to contribute to the Kubeflow SDK project. For the Kubeflow SDK documentation, please check the official Kubeflow documentation.

Requirements

Development

The Kubeflow SDK project includes a Makefile with several helpful commands to streamline your development workflow.

To install all dependencies (including dev tools) and create virtual environment, run

make install-dev

Coding Style

Make sure to install pre-commit (uv pip install pre-commit) and run pre-commit install from the root of the repository at least once before creating git commits.

The pre-commit hooks ensure code quality and consistency. They are executed in CI. PRs that fail to comply with the hooks will not be able to pass the corresponding CI gate. The hooks are only executed against staged files unless you run pre-commit run --all, in which case, they'll be executed against every file in the repository.

Specific programmatically generated files listed in the exclude field in .pre-commit-config.yaml are deliberately excluded from the hooks.

To check formatting:

make verify

Testing

The Kubeflow SDK project includes several types of tests to ensure code quality and functionality.

Unit Testing

To run unit tests locally use the following make command:

make test-python

E2E Tests

E2E test run in CI on a kind cluster using Kubeflow Trainer E2E Scripts. Clone the Kubeflow Trainer repo and run the provided commands against Trainer Makefile. For more details check the Kubeflow Trainer Contributing Guide.

Best Practices

Pull Request Title Conventions

We enforce a pull request (PR) title convention to quickly indicate the type and scope of a PR. The PR titles are used to generated changelog for releases.

PR titles must:

Examples:

  • fix: Check empty value for ml_policy
  • chore(ci): Remove unused scripts
  • feat(docs): Create guide for LLM Fine-Tuning

Kubeflow Enhancement Proposal (KEP)

For any significant features or enhancement for Kubeflow SDK project we follow the Kubeflow Enhancement Proposal process.

If you want to submit a significant change to the Kubeflow Trainer, please submit a new KEP under ./docs/proposals directory.