kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Moving and revising community expectations

This commit is contained in:
Jorge O. Castro 2018-01-22 10:34:16 -05:00
parent 5e8272ad36
commit 774750b5d2
2 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
contributors/guide/README.md
View File

@ -43,24 +43,21 @@ Welcome to Kubernetes! This document is the single source of truth for how to co
Before you can contribute, you will need to sign the [Contributor License Agreement](/CLA.md). 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](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
## Setting up your development environment ## Setting up your development environment
If you haven’t set up your environment, please find resources [here](/contributors/devel). These resources are not well organized currently; please have patience as we are working on it. If you haven’t set up your environment, please find resources [here](/contributors/devel).
## Community Expectations ## Community Expectations
Kubernetes is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment. Kubernetes is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment.
The first and foremost goal of the Kubernetes community to develop orchestration technology that radically simplifies the process of creating reliable distributed systems. However a second, equally important goal is the creation of a community that fosters easy, agile development of such orchestration systems. Read and review the [Community Expectations](/community-expectations.md) for an understand of code and review expectations.
We therefore describe the expectations for members of the Kubernetes community. This document is intended to be a living one that evolves as the community evolves via the same pull request and code review process that shapes the rest of the project. It currently covers the expectations of conduct that govern all members of the community as well as the expectations around code review that govern all active contributors to Kubernetes. ## Thanks
### Code of Conduct
Please make sure to read and observe our [Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)
### Thanks
Many thanks in advance to everyone who contributes their time and effort to making Kubernetes both a successful system as well as a successful community. The strength of our software shines in the strengths of each individual community member. Thanks! Many thanks in advance to everyone who contributes their time and effort to making Kubernetes both a successful system as well as a successful community. The strength of our software shines in the strengths of each individual community member. Thanks!

65
contributors/devel/community-expectations.md → contributors/guide/community-expectations.md
View File

@ -1,4 +1,4 @@
## Community Expectations # Community Expectations
Kubernetes is a community project. Consequently, it is wholly dependent on Kubernetes is a community project. Consequently, it is wholly dependent on
its community to provide a productive, friendly and collaborative environment. its community to provide a productive, friendly and collaborative environment.
@ -16,16 +16,9 @@ that shapes the rest of the project. It currently covers the expectations
of conduct that govern all members of the community as well as the expectations of conduct that govern all members of the community as well as the expectations
around code review that govern all active contributors to Kubernetes. around code review that govern all active contributors to Kubernetes.
### Code of Conduct ## Code review
The most important expectation of the Kubernetes community is that all members As a community we believe in the value of code review for all contributions.
abide by the Kubernetes [community code of conduct](../../governance.md#code-of-conduct).
Only by respecting each other can we develop a productive, collaborative
community.
### Code review
As a community we believe in the [value of code review for all contributions](collab.md).
Code review increases both the quality and readability of our codebase, which Code review increases both the quality and readability of our codebase, which
in turn produces high quality software. in turn produces high quality software.
@ -33,36 +26,46 @@ However, the code review process can also introduce latency for contributors
and additional work for reviewers that can frustrate both parties. and additional work for reviewers that can frustrate both parties.
Consequently, as a community we expect that all active participants in the Consequently, as a community we expect that all active participants in the
community will also be active reviewers. community will also be active reviewers. The
[community membership](../community-membership.md) outlines the responsibilities
of the different contributor roles.
We ask that active contributors to the project participate in the code review process All changes must be code reviewed. For non-maintainers this is obvious, since
in areas where that contributor has expertise. Active you can't commit anyway. But even for maintainers, we want all changes to get at
contributors are considered to be anyone who meets any of the following criteria: least one review, preferably (for non-trivial changes obligatorily) from someone
* Sent more than two pull requests (PRs) in the previous one month, or more who knows the areas the change touches. For non-trivial changes we may want two
than 20 PRs in the previous year. reviewers. The primary reviewer will make this decision and nominate a second
* Filed more than three issues in the previous month, or more than 30 issues in reviewer, if needed. Except for trivial changes, PRs should not be committed
the previous 12 months. until relevant parties (e.g. owners of the subsystem affected by the PR) have
* Commented on more than five pull requests in the previous month, or had a reasonable chance to look at PR in their local business hours.
more than 50 pull requests in the previous 12 months.
* Marked any PR as LGTM in the previous month.
* Have *collaborator* permissions in the Kubernetes github project.
In addition to these community expectations, any community member who wants to Most PRs will find reviewers organically. If a maintainer intends to be the
be an active reviewer can also add their name to an *active reviewer* file primary reviewer of a PR they should set themselves as the assignee on GitHub
(location tbd) which will make them an active reviewer for as long as they and say so in a reply to the PR. Only the primary reviewer of a change should
are included in the file. actually do the merge, except in rare cases (e.g. they are unavailable in a
reasonable timeframe).
#### Expectations of reviewers: Review comments If a PR has gone 2 work days without an owner emerging, please poke the PR
thread and ask for a reviewer to be assigned.
Except for rare cases, such as trivial changes (e.g. typos, comments) or
emergencies (e.g. broken builds), maintainers should not merge their own
changes.
Expect reviewers to request that you avoid [common go style
mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs.
## Expectations of reviewers: Review comments
Because reviewers are often the first points of contact between new members of Because reviewers are often the first points of contact between new members of
the community and can significantly impact the first impression of the the community and can significantly impact the first impression of the
Kubernetes community, reviewers are especially important in shaping the Kubernetes community, reviewers are especially important in shaping the
Kubernetes community. Reviewers are highly encouraged to review the Kubernetes community. Reviewers are highly encouraged to review the
[code of conduct](../../governance.md#code-of-conduct) and are strongly encouraged to go above [code of conduct](../../governance.md#code-of-conduct) and are strongly
and beyond the code of conduct to promote a collaborative, respectful encouraged to go above and beyond the code of conduct to promote a collaborative,
Kubernetes community. respectful Kubernetes community.
#### Expectations of reviewers: Review latency ## Expectations of reviewers: Review latency
Reviewers are expected to respond in a timely fashion to PRs that are assigned Reviewers are expected to respond in a timely fashion to PRs that are assigned
to them. Reviewers are expected to respond to an *active* PRs with reasonable to them. Reviewers are expected to respond to an *active* PRs with reasonable