| title | weight | description |
|---|---|---|
Getting Started |
1 |
A small list of things that you should read and be familiar with before you get started with contributing. This includes such things as signing the Contributor License Agreement, familiarizing yourself with our Code of Conduct and more. |
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 and file new ones, all feedback welcome!
Welcome to Kubernetes! This guide is broken up into the following sections. It is recommended that you follow these steps in order.
- Welcome - this page
- Prerequisites - things you need to complete before contributing
- Your First Contribution - things you need to know before your first contribution
- Contributing - the main guide with contributor information
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:
Before you can contribute, you will need to sign the Contributor License Agreement.
Please make sure to read and observe our Code of Conduct and Community Values
If you haven’t set up your environment, check the developer resources.
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 for an understanding of code and review expectations.
- See Community Membership for a list the various responsibilities of contributor roles. You are encouraged to move up this contributor ladder as you gain experience.
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 is the right place for you.
A Youtube playlist of the New Contributor workshop has been posted, and an outline of the video content can be found here.
If you haven't noticed by now, we have a large, lively, and friendly open-source community. We depend on new people becoming members and regular code contributors, so we would like you to come join us! The Community Membership Document covers membership processes and roles.
Kubernetes participates in KubeCon + CloudNativeCon, held three times per year in China, Europe and in North America. Information about these and other community events is available on the CNCF events pages.
We follow the general Cloud Native Computing Foundation guidelines for Meetups. You may also contact Paris Pittman via direct message on Kubernetes Slack (@paris) or by email (parispittman@google.com)
Please learn about our mentoring initiatives here. Feel free to ask us anything during our Meet Our Contributors to connect with us.
This section includes things that need to be documented, but typical contributors do not need to interact with regularly.
- OWNERS files - The Kubernetes organizations are managed with OWNERS files, which outline which parts of the code are owned by what groups.