summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authork8s-ci-robot <k8s-ci-robot@users.noreply.github.com>2018-01-23 13:44:29 -0800
committerGitHub <noreply@github.com>2018-01-23 13:44:29 -0800
commitf2e062f4c628f4e0c059887072d1c2fbdd660d10 (patch)
tree0bf437fc11a78ea56c9223c4be128744f670be52
parent35cea10e2e7b8599078b23f12293aee3ca0ae7fc (diff)
parentbf0fcc7c5da96752a4d13321cba2111cdd35ace3 (diff)
Merge pull request #1646 from castrojo/community-expectations
Moving and revising community expectations
-rw-r--r--contributors/guide/README.md17
-rw-r--r--contributors/guide/community-expectations.md (renamed from contributors/devel/community-expectations.md)49
2 files changed, 22 insertions, 44 deletions
diff --git a/contributors/guide/README.md b/contributors/guide/README.md
index a66c3aa0..341e9fca 100644
--- a/contributors/guide/README.md
+++ b/contributors/guide/README.md
@@ -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).
-## Setting up your development environment
+## 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).
-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.
+## Setting up your development environment
+If you haven’t set up your environment, please find resources [here](/contributors/devel).
## Community Expectations
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.
-
-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.
-
-### 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)
+Read and review the [Community Expectations](/community-expectations.md) for an understand of code and review expectations.
-### Thanks
+## 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!
diff --git a/contributors/devel/community-expectations.md b/contributors/guide/community-expectations.md
index 45200bc1..fa4f951f 100644
--- a/contributors/devel/community-expectations.md
+++ b/contributors/guide/community-expectations.md
@@ -1,4 +1,4 @@
-## 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.
@@ -16,53 +16,34 @@ 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.
-### Code of Conduct
+## Code review
-The most important expectation of the Kubernetes community is that all members
-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).
+As a community we believe in the value of code review for all contributions.
Code review increases both the quality and readability of our codebase, which
in turn produces high quality software.
-However, the code review process can also introduce latency for contributors
-and additional work for reviewers that can frustrate both parties.
+See the [pull request documentation](/contributors/devel/pull-requests.md) for more information
+on code review.
Consequently, as a community we expect that all active participants in the
-community will also be active reviewers.
-
-We ask that active contributors to the project participate in the code review process
-in areas where that contributor has expertise. Active
-contributors are considered to be anyone who meets any of the following criteria:
- * Sent more than two pull requests (PRs) in the previous one month, or more
- than 20 PRs in the previous year.
- * Filed more than three issues in the previous month, or more than 30 issues in
- the previous 12 months.
- * Commented on more than five pull requests in the previous month, or
- 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.
+community will also be active reviewers. The
+[community membership](/community-membership.md) outlines the responsibilities
+of the different contributor roles.
-In addition to these community expectations, any community member who wants to
-be an active reviewer can also add their name to an *active reviewer* file
-(location tbd) which will make them an active reviewer for as long as they
-are included in the file.
+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
+## Expectations of reviewers: Review comments
Because reviewers are often the first points of contact between new members of
the community and can significantly impact the first impression of the
Kubernetes community, reviewers are especially important in shaping 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
-and beyond the code of conduct to promote a collaborative, respectful
-Kubernetes community.
+[code of conduct](/governance.md#code-of-conduct) and are strongly
+encouraged to go above and beyond the code of conduct to promote a collaborative,
+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
to them. Reviewers are expected to respond to an *active* PRs with reasonable