Contributing to Kubeflow Workspaces

How to connect with the community and how to get involved

Kubeflow Workspaces is developed as part of the Kubeflow in the kubeflow/notebooks repository. Whether you want to report a bug, help triage issues, or contribute code, this page explains how to connect with the community, our planning process and the different ways you can get involved.

Joining our community

Community meetings: The Notebooks Working Group meets regularly. Find the schedule and meeting invite on the Kubeflow Community & Meetings page.
Slack: Join the #kubeflow-notebooks, introduce yourself and let us know what your skills and what you are interested in working on.

Run Locally

It is really easy to set up a local development environment for Kubeflow Workspaces, just follow the Development Guide in the repository, which walks through setting up the tilt-based workflow.

Planning process

A good overview over the current tasks can be obtained via the Kubeflow Workspaces Project Board.

The planned tasks in the project board are of the following types and organized in this hierarchy:

Task: A Task is a concrete unit of work that moves a Feature forward. A good Task provides enough context for someone to pick it up and deliver it and has its own acceptance criteria. Each Task is assigned to a single contributor who is responsible for delivering it, though they may collaborate with others. Please only assign yourself to a task after coordinating with the project maintainers on the issue or in the Slack channel.
➡️ Browse open Tasks
Feature: A Feature is a functional, often times user-facing unit of work that lives under a single Epic. Unlike an Epic, a Feature is never perpetual: it defines acceptance criteria and is closed once those criteria are met (notably: not just when all tasks that happen to be defined at the time are complete). Where applicable, a Feature may include mockups or design notes. Each Feature has an owner who shepherds its delivery and decides who takes on its sub-tasks.
➡️ Browse open Features
Epic: An Epic represents a large, ongoing area of work, for example, a complex user story or a core functional area of the project. Epics may be long-lived and are intentionally high-level: they capture what we want to achieve and why, without prescribing implementation details.
➡️ Browse open Epics

Contributor tracks

There are many ways to contribute to the project, and not all of them involve writing code. The overview below describe multiple ways of engaging with in our community and potential ways of growing as contributor and taking on more responsibility over time.

Contributing as a user of the project

ADOPTERS.md: If you use Kubeflow Workspaces feel free to add yourself to the adopters file to give the project exposure.
Bug Reporting: Report problems you run into by filing clear, reproducible issues or new information to already existing issues. Good bug reports are one of the most valuable contributions to the project.
User Stories: Share usecases and feature requests for things you would like to Kubeflow Workspaces for. Also for any currently ongoing design proposals feel free to share your input.
User Advisory Board (future): Represent your organization by sharing feedback on features and direction. If you run Kubeflow Workspaces and want your use cases heard, express your interest in joining.

Contributor ladder

Contributor: Contribute code, tests, or documentation to one of the modules.
Bug Wrangler: Help triage incoming issues: reproduce reported bugs, add missing details, idendtify duplicates, apply labels, and route issues to the right area so maintainers can act on them faster.
Code Review: Review pull requests for a part of the ecosystem you’re familiar with, i.e. React frontend code or the controller logic.

As soon as you become more involved you can potentially take on one of the following responsibilities if you’re interested and sufficiently experienced:

Reviewer/Approver: Take ownership of a specific part of the codebase (for example, the frontend, backend, or controller), including its reviews, releases, and roadmap by being added in the OWNERS file.
Proposal/Feature Owner: Shepherd a complex proposal or feature through the full lifecycle, starting from design through delivery.
Working Group Lead: Help steer the overall direction and health of the project.

Vendor Track

Organizations that build on or distribute Kubeflow Workspaces can contribute by dedicating engineering time, sponsoring features or maintainers, validating releases against their platforms and sharing feedback from their users. If your organization would like to get involved at this level, reach out to the Working Group Leads on Slack or at a community meeting.