forked from kubeflow/pipelines
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Redirect contribute guide to community repo (kubeflow#2328)
Signed-off-by: Dan Sun <dsun20@bloomberg.net>
- Loading branch information
Showing
1 changed file
with
1 addition
and
40 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 |
|---|---|---|
| @@ -1,40 +1 @@ | ||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
|
|
||
| - [How to Contribute](#how-to-contribute) | ||
| - [Contributor License Agreement](#contributor-license-agreement) | ||
| - [Code reviews](#code-reviews) | ||
| - [Get involved](#get-involved) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| # 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. | ||
|
|
||
|
|
||
| ## Code reviews | ||
|
|
||
| All submissions, including submissions by project members, require review. We | ||
| use GitHub pull requests for this purpose. Consult | ||
| [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more | ||
| information on using 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](https://chris.beams.io/posts/git-commit/) 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. | | ||
|
|
||
| ## Get involved | ||
|
|
||
| * [Kubeflow Slack channel #kubeflow-kfserving](https://kubeflow.slack.com/join/shared_invite/zt-n73pfj05-l206djXlXk5qdQKs4o1Zkg#/) | ||
| * [Kubeflow Twitter](http://twitter.com/kubeflow) | ||
| * [Kubeflow mailing list](https://groups.google.com/forum/#!forum/kubeflow-discuss) | ||
| * [KServe mailing list](https://groups.google.com/u/3/g/kserve-io) | ||
| * [KServe WG biweekly meeting](https://docs.google.com/document/d/1KZUURwr9MnHXqHA08TFbfVbM8EAJSJjmaMhnvstvi-k/edit?usp=sharing) | ||
| See [How to contribute](https://github.com/kserve/community#how-can-i-help-) in [KServe community repository](https://github.com/kserve/community). |