summaryrefslogtreecommitdiff
path: root/contributors/guide/README.md
diff options
context:
space:
mode:
authorJorge O. Castro <jorgec@vmware.com>2020-06-22 12:05:45 -0400
committerJorge O. Castro <jorgec@vmware.com>2020-06-22 12:05:45 -0400
commit67c6f7fe148a6eb5e164564ece60fea4d1a27a9e (patch)
treeee47b7ffe43824f92097e2a0657493f099a27d88 /contributors/guide/README.md
parente5a19ad6d6e677bc99cb073ae6180ccc57ff9074 (diff)
Merge getting started into the main page as they're required.
Restructure the main menu, fix up formatting. Signed-off-by: Jorge O. Castro <jorgec@vmware.com>
Diffstat (limited to 'contributors/guide/README.md')
-rw-r--r--contributors/guide/README.md52
1 files changed, 44 insertions, 8 deletions
diff --git a/contributors/guide/README.md b/contributors/guide/README.md
index 6b1e834f..edf54320 100644
--- a/contributors/guide/README.md
+++ b/contributors/guide/README.md
@@ -1,16 +1,26 @@
+# Welcome
+
+Have you ever wanted to contribute to the coolest cloud technology?
+We will help you understand the organization of the Kubernetes project and direct you to the best places to get started.
+You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged.
+
This document is the single source of truth for how to contribute to the code base.
Feel free to browse the [open issues](https://github.com/kubernetes/community/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcontributor-guide) and file new ones, all feedback welcome!
-# Welcome
+## Contributor Guide
+
+Welcome to Kubernetes! This guide is broken up into the following sections.
+It is recommended that you follow these steps in order.
-Welcome to Kubernetes!
+- [Welcome](#welcome) - this page
+- [Prerequisites](#prerequisites) - things you need to complete before contributing
+- [Your First Contribution](first-contribution.md) - things you need to know before your first contribution
+- [Contributing](contributing.md) - the main guide with contributor information
+
+## Resources Available
-- [Welcome](#welcome)
-- [Before you get started](getting-started.md)
-- [Your First Contribution](first-contribution.md)
-- [Contributing](contributing.md)
- [Kubernetes Contributor Playground](#kubernetes-contributor-playground)
- - [Youtube playlist](#youtube-playlist)
+- [Contributor Workshops](#contributor-workshops)
- [Community](#community)
- [Communication](#communication-1)
- [Events](#events)
@@ -18,11 +28,36 @@ Welcome to Kubernetes!
- [Mentorship](#mentorship)
- [Advanced Topics](#advanced-topics)
+# Prerequisites
+
+Before submitting code to the project you should first take care of the following prerequisites.
+These steps are checked by a bot during your first submission, so doing these steps first will make your first contribution easier:
+
+## Sign the CLA
+
+Before you can contribute, you will need to sign the [Contributor License Agreement](/CLA.md).
+
+## Code of Conduct
+
+Please make sure to read and observe our [Code of Conduct](/code-of-conduct.md) and [Community Values](/values.md)
+
+## Setting up your development environment
+
+If you haven’t set up your environment, check the [developer resources](/contributors/devel/README.md#setting-up-your-dev-environment-coding-and-debugging).
+
+## Community Expectations and Roles
+
+Kubernetes is a community project.
+Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.
+
+- Read and review the [Community Expectations](expectations.md) for an understanding of code and review expectations.
+- See [Community Membership](/community-membership.md) for a list the various responsibilities of contributor roles. You are encouraged to move up this contributor ladder as you gain experience.
+
# Kubernetes Contributor Playground
If you are looking for a safe place, where you can familiarize yourself with (some of) the Kubernetes Project's review and pull request processes, then the [Kubernetes Contributor Playground](https://github.com/kubernetes-sigs/contributor-playground/) is the right place for you.
-## Youtube playlist
+## Contributor Workshops
A [Youtube playlist](https://www.youtube.com/playlist?list=PL69nYSiGNLP3M5X7stuD7N4r3uP2PZQUx) of the New Contributor workshop has been posted, and an outline of the video content can be found [here](/events/2018/05-contributor-summit).
@@ -50,6 +85,7 @@ You may also contact Paris Pittman via direct message on Kubernetes Slack (@pari
Please learn about our mentoring initiatives [here](http://git.k8s.io/community/mentoring/README.md).
Feel free to ask us anything during our [Meet Our Contributors](https://github.com/kubernetes/community/blob/master/mentoring/programs/meet-our-contributors.md) to connect with us.
+
# Advanced Topics
This section includes things that need to be documented, but typical contributors do not need to interact with regularly.