diff options
| author | Kubernetes Submit Queue <k8s-merge-robot@users.noreply.github.com> | 2017-12-14 13:29:35 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-14 13:29:35 -0800 |
| commit | 84f6f5df941e84f2154181ac47630e7cf0bfe878 (patch) | |
| tree | 6530470f10e60f32d5ebc08b8667ba4b5a6e3e54 | |
| parent | 87c35a279ea800623f6e3d28c32a7b9394dcfe58 (diff) | |
| parent | 62be7e1aae19a609b9d5e3da0920028dbc565f9f (diff) | |
Merge pull request #1507 from tpepper/contrib_guide
Automatic merge from submit-queue.
contrib guide: add table of contents
We're to a point were a table of contents at the top of the contrib guide
is informative on overall flow of the doc. Will need to regenerate this
if/when new sections are added since it's not a render-time artifact.
Relates to issues #1413.
Signed-off-by: Tim Pepper <tpepper@vmware.com>
| -rw-r--r-- | contributors/guide/README.md | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/contributors/guide/README.md b/contributors/guide/README.md index 38754360..f0898fb3 100644 --- a/contributors/guide/README.md +++ b/contributors/guide/README.md @@ -23,12 +23,37 @@ _Improvements needed_ * Individual SIG contributing documents -> add a link to this guide -* Generate ToC for the section below - # Welcome Welcome to Kubernetes! This document is the single source of truth for how to contribute to the code base. Please leave comments / suggestions if you find something is missing or incorrect. +- [Before you get started](#before-you-get-started) + - [Sign the CLA](#sign-the-cla) + - [Setting up your development + environment](#setting-up-your-development-environment) + - [Community Expectations](#community-expectations) + - [Code of Conduct](#code-of-conduct) + - [Thanks](#thanks) +- [Your First Contribution](#your-first-contribution) + - [Find something to work on](#find-something-to-work-on) + - [Find a good first topic](#find-a-good-first-topic) + - [Learn about SIGs](#learn-about-sigs) + - [File an Issue](#file-an-issue) +- [Contributing](#contributing) + - [Communication](#communication) + - [GitHub workflow](#github-workflow) + - [Open a Pull Request](#open-a-pull-request) + - [Code Review](#code-review) + - [Testing](#testing) + - [Security](#security) + - [Documentation](#documentation) + - [Issues Management or Triage](#issues-management-or-triage) +- [Community](#community) + - [Events](#events) + - [Meetups](#meetups) + - [KubeCon](#kubecon) + - [Mentorship](#mentorship) + # Before you get started ## Sign the CLA |