Skip to content

Commit a94e084

Browse files
authored
Merge pull request #5149 from celanthe/patch-2
Updated readme.md to align with style guide
2 parents b9f5b86 + f2766fa commit a94e084

File tree

1 file changed

+118
-61
lines changed

1 file changed

+118
-61
lines changed

contributors/guide/README.md

Lines changed: 118 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,100 +5,157 @@ aliases: [ "/guide" ]
55
description:
66
A small list of things that you should read and be familiar with before you
77
get started with contributing. This includes such things as signing the
8-
Contributor License Agreement, familiarizing yourself with our Code of Conduct
8+
Contributor License Agreement, familiarizing yourself with our Code of Conduct,
99
and more.
1010
---
1111

12-
# Welcome
12+
# Getting Started
13+
14+
- [Getting Started](#getting-started)
15+
- [Welcome](#welcome)
16+
- [Contributor Guide](#contributor-guide)
17+
- [Resources Available](#resources-available)
18+
- [Prerequisites](#prerequisites)
19+
- [Sign the CLA](#sign-the-CLA)
20+
- [Code of Conduct](#code-of-conduct)
21+
- [Setting Up Your Developer Environment](#setting-up)
22+
- [Community Expectations and Roles](#community-expectations)
23+
- [Contributor Playground](#contributor-playground)
24+
- [Contributor Workshops](#contributor-workshops)
25+
- [Community](#community)
26+
- [Communication](#communication)
27+
- [Events](#events)
28+
- [Meetups](#meetups)
29+
- [Mentorship](#mentorship)
30+
- [Advanced Topics](#advanced-topics)
31+
32+
## Welcome
1333

1434
Have you ever wanted to contribute to the coolest cloud technology?
15-
We will help you understand the organization of the Kubernetes project and direct you to the best places to get started.
16-
You'll be able to pick up issues, write code to fix them, and get your work reviewed and merged.
35+
This guide will help you understand the overall organization of the Kubernetes
36+
project, and direct you to the best places to get started contributing. You'll
37+
be able to pick up issues, write code to fix them, and get your work reviewed
38+
and merged.
1739

18-
This document is the single source of truth for how to contribute to the code base.
19-
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!
40+
This document is the single source of truth for how to contribute to the code
41+
base. Feel free to browse the [open issues] and file new ones, all feedback
42+
is welcome!
2043

2144
## Contributor Guide
2245

23-
Welcome to Kubernetes! This guide is broken up into the following sections.
24-
It is recommended that you follow these steps in order.
46+
Welcome to Kubernetes! This guide is broken up into the following sections.
47+
It is recommended that you follow these steps in order:
2548

2649
- [Welcome](#welcome) - this page
27-
- [Prerequisites](#prerequisites) - things you need to complete before contributing
28-
- [Your First Contribution](first-contribution.md) - things you need to know before your first contribution
29-
- [Contributing](contributing.md) - the main guide with contributor information
50+
- [Prerequisites](#prerequisites) - tasks you need to complete before
51+
you can start contributing to Kubernetes
52+
- [Your First Contribution](#first-contribution) - things you'll need to know
53+
before making your first contribution
54+
- [Contributing](#contributing) - the main reference guide to contributing
55+
to Kubernetes
3056

31-
## Resources Available
57+
## Prerequisites
3258

33-
- [Kubernetes Contributor Playground](#kubernetes-contributor-playground)
34-
- [Contributor Workshops](#contributor-workshops)
35-
- [Community](#community)
36-
- [Communication](#communication-1)
37-
- [Events](#events)
38-
- [Meetups](#meetups)
39-
- [Mentorship](#mentorship)
40-
- [Advanced Topics](#advanced-topics)
41-
42-
# Prerequisites
59+
Before submitting code to Kubernetes, you should first complete the following
60+
prerequisites. These steps are checked automatically by [a bot] during your
61+
first submission. Completing these steps will make your first contribution
62+
easier:
4363

44-
Before submitting code to the project you should first take care of the following prerequisites.
45-
These steps are checked by a bot during your first submission, so doing these steps first will make your first contribution easier:
64+
### Sign the CLA
4665

47-
## Sign the CLA
66+
Before you can contribute to Kubernetes, you will need to sign the
67+
[Contributor License Agreement].
4868

49-
Before you can contribute, you will need to sign the [Contributor License Agreement](/CLA.md).
69+
### Code of Conduct
5070

51-
## Code of Conduct
71+
Please make sure to read and observe the [Code of Conduct] and
72+
[Community Values]
5273

53-
Please make sure to read and observe our [Code of Conduct](/code-of-conduct.md) and [Community Values](/values.md)
74+
### Setting up your development environment
5475

55-
## Setting up your development environment
76+
It is not required to set up a developer environment in order to contribute to
77+
Kubernetes.
5678

57-
If you haven’t set up your environment, check the [developer resources](/contributors/devel/README.md#setting-up-your-dev-environment-coding-and-debugging).
79+
If you plan to contribute code changes, review the [developer resources] page
80+
for how to set up your environment.
5881

59-
## Community Expectations and Roles
82+
### Community Expectations and Roles
6083

61-
Kubernetes is a community project.
62-
Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.
84+
Kubernetes is a community project. Consequently, it is wholly dependent on its
85+
community to provide a productive, friendly and collaborative environment.
6386

64-
- Read and review the [Community Expectations](expectations.md) for an understanding of code and review expectations.
65-
- 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.
87+
- Read and review the [Community Expectations] for an
88+
understanding of code and review expectations.
89+
- See [Community Membership][CM] for a list the various
90+
responsibilities of contributor roles.
91+
- You are encouraged to move up this contributor ladder as you gain experience.
6692

67-
# Kubernetes Contributor Playground
93+
## Kubernetes Contributor Playground
6894

69-
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.
95+
If you are looking for a safe place, where you can familiarize yourself with
96+
the pull request and issue review process in Kubernetes, then the
97+
[Kubernetes Contributor Playground] is the right place for you.
7098

71-
## Contributor Workshops
99+
### Contributor Workshops
72100

73-
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).
101+
A [Youtube playlist] of the New Contributor workshop has been posted. An
102+
outline of the video content can be found [here].
74103

75-
# Community
104+
## Community
76105

77-
If you haven't noticed by now, we have a large, lively, and friendly open-source community.
78-
We depend on new people becoming members and regular code contributors, so we would like you to come join us!
79-
The [Community Membership Document](/community-membership.md) covers membership processes and roles.
106+
Kubernetes is a large, lively, friendly open-source community. As many open
107+
ource projects often do, it depends on new people becoming members and regular
108+
code contributors. The [Community Membership Document][CM] covers membership
109+
processes and roles. Please consider joining Kubernetes, and making your way
110+
up the contributor ladder!
80111

81-
## Communication
112+
### Communication
82113

83-
- [General Information](/communication)
114+
- [General Information] relating to Kubernetes communication policies
84115

85-
## Events
116+
### Events
86117

87-
Kubernetes participates in KubeCon + CloudNativeCon, held three times per year in China, Europe and in North America.
88-
Information about these and other community events is available on the CNCF [events](https://www.cncf.io/events/) pages.
118+
Kubernetes participates in KubeCon + CloudNativeCon, held three times per year
119+
in China, Europe and in North America. Information about these and other
120+
community events is available on the CNCF [Events] pages.
89121

90122
### Meetups
91123

92-
We follow the general [Cloud Native Computing Foundation guidelines](https://github.com/cncf/communitygroups) for Meetups.
93-
You may also contact CNCF Staff driving the Community Groups (previously known as Meetups) program by email ([email protected])
94-
95-
## Mentorship
96-
97-
Please learn about our mentoring initiatives [here](http://git.k8s.io/community/mentoring/README.md).
98-
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.
99-
100-
# Advanced Topics
101-
102-
This section includes things that need to be documented, but typical contributors do not need to interact with regularly.
103-
104-
- [OWNERS files](owners.md) - The Kubernetes organizations are managed with OWNERS files, which outline which parts of the code are owned by what groups.
124+
All Kubernetes meetups follow the general [Cloud Native Computing Foundation Guidelines]
125+
You may also contact CNCF Staff driving the Community Groups (previously known
126+
as Meetups) program by email ([email protected])
127+
128+
### Mentorship
129+
130+
Learn more about the Kubernetes [mentoring initiatives]. Join past and present
131+
Kubernetes Contributors for a live question-and-answer session during
132+
[Meet Our Contributors].
133+
134+
## Advanced Topics
135+
136+
This section includes things that need to be documented, but typical contributors
137+
do not need to interact with regularly.
138+
139+
- [OWNERS files] - The Kubernetes organizations are managed with OWNERS files,
140+
which outline which parts of the code are owned by what groups.
141+
142+
143+
[a bot]: https://github.com/k8s-ci-robot
144+
[Contributor License Agreement]: /CLA.md
145+
[Code of Conduct]: /code-of-conduct.md
146+
[Community Values]: /values.md
147+
[First Contribution]: ./first-contribution.md
148+
[Contributing]: ./contributing.md
149+
[Developer Resources]: /contributors/devel/README.md#setting-up-your-dev-environment-coding-and-debugging
150+
[Community Expectations]: ./expectations.md
151+
[CM]: /community-membership.md
152+
[here]: /events/2019/11-contributor-summit
153+
[General Information]: /communication
154+
[mentoring initiatives]: /mentoring/README.md
155+
[Meet Our Contributors]: /mentoring/programs/meet-our-contributors.md
156+
[OWNERS files]: ./owners.md
157+
[Cloud Native Computing Foundation Guidelines]: https://github.com/cncf/communitygroups
158+
[Events]: https://www.cncf.io/events/
159+
[YouTube Playlist]: https://www.youtube.com/playlist?list=PL69nYSiGNLP3M5X7stuD7N4r3uP2PZQUx
160+
[Kubernetes Contributor Playground]: https://github.com/kubernetes-sigs/contributor-playground/blob/master/README.md
161+
[Open Issues]: https://github.com/kubernetes/community/issues?q=is%3Aissue+is%3Aopen+label%3Aarea%2Fcontributor-guide

0 commit comments

Comments
 (0)