Contributor Cheatsheet

Mon, 01 Jan 0001 00:00:00 +0000

A list of common resources when contributing to Kubernetes, tips, tricks, and common best practices used within the Kubernetes project. It is a “TL;DR” or quick reference of useful information to make your GitHub contribution experience better.

Table of Contents

Helpful Resources
Communicating Effectively on GitHub
- How to be Excellent to Each Other
  - Examples of Good/Bad Communication
Submitting a Contribution
Working Locally
- Branch Strategy

Helpful Resources

Getting Started

Contributor Course - NEW - The E-Learning for Contributors course for Kubernetes!
Contributor Guide - Guide on how to begin contributing to Kubernetes Project.
Developer Guide - Guide to contributing code directly to the Kubernetes Project.
Security and Disclosure Information - Guide for reporting vulnerabilities and the security release process.

SIGs and Other Groups

Master Group List

Community

Calendar - View all the Kubernetes Community events (SIG/WG meetings, events etc.)
kubernetes-dev - The Kubernetes development mailing list
Kubernetes Forum - Official Kubernetes forum.
Slack channels - Official Kubernetes Slack.
Stack Overflow - A place to ask your Kubernetes end-user questions.
YouTube Channel - Official channel for the Kubernetes community.

Workflow

Prow - Kubernetes CI/CD System.
Tide - Prow plugin that manages merges and tests. Tide Dashboard
Bot commands - Commands used to interact with Kubernetes Bots (examples: /cc, /lgtm, and /retest)
GitHub labels - List of labels used throughout the Kubernetes Project
Kubernetes Code Search , maintained by @dims

Tests

Prow - Kubernetes CI/CD System.
Test Grid - View historical tests and their associated information.
Triage Dashboard - Aggregates similar failures together for better troubleshooting.

Important Email Aliases

community@kubernetes.io - Mail someone on the community team (SIG Contributor Experience) about a community issue.
conduct@kubernetes.io - Contact the Code of Conduct committee, private mailing list.
github@kubernetes.io - Mail the GitHub Administration Team privately, for sensitive items.
steering@kubernetes.io - Mail the steering committee. Public address with public archive.
steering-private@kubernetes.io - Mail the steering committee privately, for sensitive items.
social@cncf.io - Contact the CNCF social team; blog, twitter account, and other social properties.

Communicating Effectively on GitHub

How to be Excellent to Each Other

As a first step, familiarize yourself with the Code of Conduct .

Documentation on Kubernetes Contributors