Skip to content

Latest commit

 

History

History
167 lines (121 loc) · 7.62 KB

CONTRIBUTING.md

File metadata and controls

167 lines (121 loc) · 7.62 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Table of Contents

Project Structure

Kubeflow Pipelines consists of multiple components. Before you begin, learn how to build the Kubeflow Pipelines component container images.

To get started, see the development guides:

Legal

Kubeflow uses Developer Certificate of Origin (DCO).

Please see https://github.com/kubeflow/community/tree/master/dco-signoff-hook#signing-off-commits to learn how to sign off your commits.

Coding Style

The Python part of the project will follow Google Python style guide. We provide a yapf configuration file to help contributors auto-format their code to adopt the Google Python style. Also, it is encouraged to lint python docstrings by docformatter.

The frontend part of the project uses prettier for formatting, read frontend/README.md#code-style for more details.

Unit Testing Best Practices

  • Testing via Public APIs

Golang

  • Put your tests in a different package: Moving your test code out of the package allows you to write tests as though you were a real user of the package. You cannot fiddle around with the internals, instead you focus on the exposed interface and are always thinking about any noise that you might be adding to your API. Usually the test code will be put under the same folder but with a package suffix of _test. https://golang.org/src/go/ast/example_test.go (example)
  • Internal tests go in a different file: If you do need to unit test some internals, create another file with _internal_test.go as the suffix.
  • Write table-driven tests: https://github.com/golang/go/wiki/TableDrivenTests (example)

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Pull Requests

The following should be viewed as Best Practices unless you know better ones (please submit a guidelines PR).

Practice Rationale
Keep the code clean The health of the codebase is imperative to the success of the project. Files should be under 500 lines long in most cases, which may mean a refactor is necessary before adding changes.
Limit your scope No one wants to review a 1000 line PR. Try to keep your changes focused to ease reviewability. This may mean separating a large feature into several smaller milestones.
Refine commit messages Your commit messages should be in the imperative tense and clearly describe your feature upon first glance. See this article for guidelines.
Reference an issue Issues are a great way to gather design feedback from the community. To save yourself time on a controversial PR, first cut an issue for any major feature work.

Pull Request Title Convention

We enforce a pull request (PR) title convention to quickly indicate the type and scope of a PR. PR titles become commit messages when PRs are merged. We also parse PR titles to generate the changelog.

PR titles should:

Examples:

  • fix(ui): fixes empty page. Fixes #1234
  • feat(backend): configurable service account. Fixes #1234, fixes #1235
  • chore: refactor some files
  • test: fix CI failure. Part of #1234

The following sections describe the details of the PR title convention.

PR Title Structure

PR titles should use the following structure.

<type>[optional scope]: <description>[ Fixes #<issue-number>]

Replace the following:

  • <type>: The PR type describes the reason for the change, such as fix to indicate that the PR fixes a bug. More information about PR types is available in the next section.
  • [optional scope]: (Optional.) The PR scope describes the part of Kubeflow Pipelines that this PR changes, such as frontend to indicate that the change affects the user interface. Choose a scope according to PR Scope section.
  • <description>: A user friendly description of this change.
  • [ Fixes #<issues-number>]: (Optional.) Specifies the issues fixed by this PR.

PR Type

Type can be one of the following:

  • feat: A new feature.
  • fix: A bug fix. However, a PR that fixes test infrastructure is not user facing, so it should use the test type instead.
  • docs: Documentation changes.
  • chore: Anything else that does not need to be user facing.
  • test: Adding or updating tests only. Please note, feat and fix PRs should have related tests too.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • perf: A code change that improves performance.

Note, only feature, fix and perf type PRs will be included in CHANGELOG, because they are user facing.

If you think the PR contains multiple types, you can choose the major one or split the PR to focused sub-PRs.

If you are not sure which type your PR is and it does not have user impact, use chore as the fallback.

PR Scope

Scope is optional, it can be one of the following:

  • frontend: user interface or frontend server related, folder frontend, frontend/server
  • backend: Backend, folder backend
  • sdk: kfp python package, folder sdk
  • sdk/client: kfp-server-api python package, folder backend/api/python_http_client
  • components: Pipeline components, folder components
  • deployment: Kustomize or gcp marketplace manifests, folder manifests
  • metadata: Related to machine learning metadata (MLMD), folder backend/metadata_writer
  • cache: Caching, folder backend/src/cache
  • swf: Scheduled workflow, folder backend/src/crd/controller/scheduledworkflow
  • viewer: Tensorboard viewer, folder backend/src/crd/controller/viewer

If you think the PR is related to multiple scopes, you can choose the major one or split the PR to focused sub-PRs. Note, splitting large PRs that affect multiple scopes can help make it easier to get your PR reviewed, since different scopes usually have different reviewers.

If you are not sure, or the PR doesn't fit into above scopes. You can either omit the scope because it's optional, or propose an additional scope here.

Get Involved