From 657cb5130fec4c1683de3120a7d703538587dfda Mon Sep 17 00:00:00 2001 From: "Jorge O. Castro" Date: Mon, 29 Jul 2019 10:51:46 -0400 Subject: Update URL to just "expectations" so the URL reads right in the contrib guide --- community-membership.md | 2 +- contributors/guide/README.md | 6 +-- contributors/guide/community-expectations.md | 68 ---------------------------- contributors/guide/expectations.md | 68 ++++++++++++++++++++++++++++ mentoring/group-mentee-guide.md | 2 +- 5 files changed, 73 insertions(+), 73 deletions(-) delete mode 100644 contributors/guide/community-expectations.md create mode 100644 contributors/guide/expectations.md diff --git a/community-membership.md b/community-membership.md index 49d3d4ab..5dd538da 100644 --- a/community-membership.md +++ b/community-membership.md @@ -228,7 +228,7 @@ The following apply to the subproject for which one would be an owner. The Maintainer role has been removed and replaced with a greater focus on [OWNERS]. [code reviews]: /contributors/guide/collab.md -[community expectations]: /contributors/guide/community-expectations.md +[community expectations]: /contributors/guide/expectations.md [contributor guide]: /contributors/guide/README.md [Kubernetes GitHub Admin team]: /github-management/README.md#github-administration-team [Kubernetes GitHub organizations]: /github-management#actively-used-github-organizations diff --git a/contributors/guide/README.md b/contributors/guide/README.md index a3abf817..d6040224 100644 --- a/contributors/guide/README.md +++ b/contributors/guide/README.md @@ -66,7 +66,7 @@ If you haven’t set up your environment, check the [developer resources](/contr Kubernetes is a community project. Consequently, it is wholly dependent on its community to provide a productive, friendly and collaborative environment. -- Read and review the [Community Expectations](community-expectations.md) for an understanding of code and review expectations. +- Read and review the [Community Expectations](expectations.md) for an understanding of code and review expectations. - 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. # Your First Contribution @@ -213,7 +213,7 @@ Common new contributor PR issues are: ## Code Review -For a brief description of the importance of code review, please read [On Code Review](/contributors/guide/community-expectations.md#code-review). +For a brief description of the importance of code review, please read [On Code Review](/contributors/guide/expectations.md#code-review). There are two aspects of code review: giving and receiving. To make it easier for your PR to receive reviews, consider the reviewers will need you to: @@ -223,7 +223,7 @@ To make it easier for your PR to receive reviews, consider the reviewers will ne * break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue * label PRs with appropriate SIGs and reviewers: to do this read the messages the bot sends you to guide you through the PR process -Reviewers, the people giving the review, are highly encouraged to revisit the [Code of Conduct](/code-of-conduct.md) as well as [community expectations](./community-expectations.md#expectations-of-reviewers-review-latency) and must go above and beyond to promote a collaborative, respectful community. +Reviewers, the people giving the review, are highly encouraged to revisit the [Code of Conduct](/code-of-conduct.md) as well as [community expectations](./expectations.md#expectations-of-reviewers-review-latency) and must go above and beyond to promote a collaborative, respectful community. When reviewing PRs from others [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with nuances: * Is the idea behind the contribution sound? diff --git a/contributors/guide/community-expectations.md b/contributors/guide/community-expectations.md deleted file mode 100644 index dabbb248..00000000 --- a/contributors/guide/community-expectations.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: "Community Expectations" -weight: 1 -slug: "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 is 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 PR 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 review - -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. - -See the [pull request documentation](/contributors/guide/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. The -[community membership](/community-membership.md) outlines the responsibilities -of the different contributor roles. - -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 -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. - -## 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 -latency, and if reviewers fail to respond, those PRs may be assigned to other -reviewers. - -If reviewers are unavailable to review for some time, they are expected to set their [user status](https://help.github.com/en/articles/personalizing-your-profile#setting-a-status) to "busy" so that the bot will not request reviews from them on new PRs automatically. If they are unavailable for a longer period of time, they are expected to remove themselves from the OWNERS file and potentially nominate someone else. - -*Active* PRs are considered those which have a proper CLA (`cla:yes`) label -and do not need rebase to be merged. PRs that do not have a proper CLA, or -require a rebase are not considered active PRs. - -## 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/guide/expectations.md b/contributors/guide/expectations.md new file mode 100644 index 00000000..dabbb248 --- /dev/null +++ b/contributors/guide/expectations.md @@ -0,0 +1,68 @@ +--- +title: "Community Expectations" +weight: 1 +slug: "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 is 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 PR 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 review + +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. + +See the [pull request documentation](/contributors/guide/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. The +[community membership](/community-membership.md) outlines the responsibilities +of the different contributor roles. + +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 +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. + +## 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 +latency, and if reviewers fail to respond, those PRs may be assigned to other +reviewers. + +If reviewers are unavailable to review for some time, they are expected to set their [user status](https://help.github.com/en/articles/personalizing-your-profile#setting-a-status) to "busy" so that the bot will not request reviews from them on new PRs automatically. If they are unavailable for a longer period of time, they are expected to remove themselves from the OWNERS file and potentially nominate someone else. + +*Active* PRs are considered those which have a proper CLA (`cla:yes`) label +and do not need rebase to be merged. PRs that do not have a proper CLA, or +require a rebase are not considered active PRs. + +## 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/mentoring/group-mentee-guide.md b/mentoring/group-mentee-guide.md index 07ee17ba..bbf7c648 100644 --- a/mentoring/group-mentee-guide.md +++ b/mentoring/group-mentee-guide.md @@ -69,7 +69,7 @@ Suggested Activity - the docs - k/community is your friend for upstream workflows, processes, and information around contributing - This repo includes the community/devel folder which will be extra helpful that includes docs such as: - - [Code Review Expectations](/contributors/guide/community-expectations.md) + - [Code Review Expectations](/contributors/guide/expectations.md) - [Collaboration on k8s](/contributors/guide/collab.md) -- cgit v1.2.3