-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
162 changed files
with
14,698 additions
and
1,954 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,13 +3,6 @@ | |
We'd love to accept your patches and contributions to this project. There are | ||
just a few small guidelines you need to follow. | ||
|
||
## Project Structure | ||
|
||
Kubeflow Pipelines consists of multiple components. Before you begin, learn how to [build the Kubeflow Pipelines component container images](./developer_guide.md##build-image). To get started, see the development guides: | ||
|
||
* [Frontend development guide](./frontend/README.md) | ||
* [Backend development guide](./backend/README.md) | ||
|
||
## Contributor License Agreement | ||
|
||
Contributions to this project must be accompanied by a Contributor License | ||
|
@@ -22,6 +15,68 @@ You generally only need to submit a CLA once, so if you've already submitted one | |
(even if it was for a different project), you probably don't need to do it | ||
again. | ||
|
||
## Contribution Guidelines | ||
|
||
To propose a new feature or a change that alters some existing user experience | ||
or creates a new user experience, follow these steps: | ||
|
||
### Step 1: Establish Context | ||
|
||
Search on KFP GitHub issues list to see if the same or similar proposal has been | ||
made in the past. The historical context can help you draft a better | ||
proposal. Sometimes you will find a very similar proposal was already presented, | ||
discussed thoroughly, and that it is either awaiting contribution (in active | ||
development) or was rejected (often due to timing or conflicting scope with | ||
other plans). To avoid confusion and conflicts, where possible, please | ||
contribute to existing issues before creating new ones. | ||
|
||
### Step 2: Create Feature Request | ||
|
||
Create a new issue using the “Feature Request” template if no existing issue is | ||
found. Fill in answers to the template questions. To avoid delays, provide as | ||
much information as needed for initial review. Keep in mind that new features | ||
should comply with backward-compatibility and platform-portability requirements. | ||
|
||
### Step 3: Initial Team Triage | ||
|
||
Wait for a member from the Kubeflow Pipelines team (under | ||
orgs/kubeflow/teams/pipelines/ in | ||
[org.yaml](https://raw.githubusercontent.com/kubeflow/internal-acls/master/github-orgs/kubeflow/org.yaml)) | ||
to comment on the issue. The team aims for triaging new issues on a weekly | ||
basis, but cannot at this time provide a guarantee on when your issue will be | ||
reviewed. The team will work with you to determine if your change is trivial and | ||
can proceed or whether it is nontrivial and needs a more detailed design | ||
document and review. | ||
|
||
### Step 4: Design Review | ||
|
||
If the team agreed with the overall proposal, you would be asked to write a | ||
design documentation, explaining why you want to make a change, what changes are | ||
you proposing, and how do you plan to implement it. The design review process | ||
would be required by default unless the team agreed that the change is too | ||
trivial. It is recommended that you use this [Google doc template](https://docs.google.com/document/d/1VrfuMo8ZeMmV75a-rUq9SO-E6KotBodAf-P0WZeFDZA/edit?usp=sharing&resourcekey=0-BklOgu8ivhdLCplZuPDZZg) | ||
for your design, and share it with [email protected] for | ||
commenting. After sharing the design documentation, you could optionally join a | ||
session of the bi-weekly Kubeflow Pipelines community meetings | ||
[[agenda](http://bit.ly/kfp-meeting-notes)] to present or further discuss your | ||
proposal. A proposal may still get rejected at this stage if it comes with | ||
unresolved drawbacks or if it does not align with the long term plans for the | ||
project. | ||
|
||
### Step 5: Implementation | ||
|
||
After you get formal approval from a Kubeflow Pipelines team member, you can | ||
implement your design and send a pull request. Make sure existing tests are all | ||
passing and new tests are added when applicable. Remember to link to the feature | ||
request issue to help reviewers catch up on the context. | ||
|
||
## Project Structure | ||
|
||
Kubeflow Pipelines consists of multiple components. Before you begin, learn how to [build the Kubeflow Pipelines component container images](./developer_guide.md##build-image). To get started, see the development guides: | ||
|
||
* [Frontend development guide](./frontend/README.md) | ||
* [Backend development guide](./backend/README.md) | ||
|
||
## Coding style | ||
|
||
### SDK | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
..._http_client/pipeline_upload_client/pipeline_upload_service/upload_pipeline_parameters.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
29 changes: 29 additions & 0 deletions
29
...ient/pipeline_upload_client/pipeline_upload_service/upload_pipeline_version_parameters.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
// Copyright 2022 The Kubeflow Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
syntax = "proto3"; | ||
|
||
option go_package = "github.com/kubeflow/pipelines/backend/api/v2beta1/go_client"; | ||
package v2beta1; | ||
|
||
import "google/protobuf/any.proto"; | ||
|
||
message Error { | ||
string error_message = 1; | ||
string error_details = 2; | ||
} | ||
|
||
message Status { | ||
string error = 1; | ||
int32 code = 2; | ||
repeated google.protobuf.Any details = 3; | ||
} |
Oops, something went wrong.