Skip to content

Commit f9daf57

Browse files
tarilabspboyd
andauthored
docs: refresh CONTRIBUTING.md (kubeflow#1086)
* docs: refresh CONTRIBUTING.md Signed-off-by: Matteo Mortari <[email protected]> * Update CONTRIBUTING.md Co-authored-by: Paul Boyd <[email protected]> Signed-off-by: Matteo Mortari <[email protected]> --------- Signed-off-by: Matteo Mortari <[email protected]> Co-authored-by: Paul Boyd <[email protected]>
1 parent a9d4d7d commit f9daf57

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# Kubeflow Contributor Guide
22

3-
Welcome to the Kubeflow project! We'd love to accept your patches and
3+
Welcome to the Kubeflow Model Registry project! We'd love to accept your patches and
44
contributions to this project. Please read the
55
[contributor's guide in our docs](https://www.kubeflow.org/docs/about/contributing/).
66

7-
The contributor's guide
7+
The contributor's guide:
88

9-
* shows you where to find the Contributor License Agreement (CLA) that you need
10-
to sign,
11-
* helps you get started with your first contribution to Kubeflow,
12-
* and describes the pull request and review workflow in detail, including the
13-
OWNERS files and automated workflow tool.
9+
* explains how to use the Developer Certificate of Origin (DCO) with git commit system
10+
* like explained in [this guide](https://wiki.linuxfoundation.org/dco), or [this example](https://github.com/kubeflow/community/tree/master/dco-signoff-hook#signing-off-commits)
11+
* references the [Code of Conduct](https://www.kubeflow.org/docs/about/contributing/#follow-the-code-of-conduct)
12+
* helps you get started with your first contribution to Kubeflow
13+
* like how to identify [good-first-issue](https://github.com/kubeflow/model-registry/labels/good%20first%20issue) tickets
14+
* and [describes](https://www.kubeflow.org/docs/about/contributing/#owners-files-and-pr-workflow) the pull request and review workflow in detail, including the
15+
OWNERS files and automated workflow tool
1416

1517
<hr/>
1618

17-
This document focus on technical aspects while contributing to the Model Registry project
19+
The remainder of this document focuses on technical aspects while contributing to the Model Registry project specifically.
20+
21+
Don't forget to reference the [Model Registry documentation](https://github.com/kubeflow/model-registry?tab=readme-ov-file#documentation-links) that details: what is a Model Registry, how to Install, logical model Concepts, how the MR python client works, Tutorials, FAQs and most importantly the [Technical References](https://github.com/kubeflow/model-registry?tab=readme-ov-file#documentation-links:~:text=FAQs-,Development,-introduction%20to%20local)!
1822

1923
# Contributing to Model Registry using Apple-silicon/ARM-based computers
2024

0 commit comments

Comments
 (0)