Skip to content

Commit 5754713

Browse files
committed
review changes
1 parent c96c042 commit 5754713

File tree

3 files changed

+34
-17
lines changed

3 files changed

+34
-17
lines changed

docs/devel/pr_workflow.dia

1.17 KB
Binary file not shown.

docs/devel/pr_workflow.png

51.7 KB
Loading

docs/devel/pull-requests.md

+34-17
Original file line numberDiff line numberDiff line change
@@ -34,37 +34,54 @@ Documentation for other releases can be found at
3434
Pull Request Process
3535
====================
3636

37-
An overview of how we will manage old or out-of-date pull requests.k
38-
Process
39-
-------
40-
41-
We will close any pull requests older than two weeks.
42-
43-
Exceptions can be made for PRs that have active review comments, or that are awaiting other dependent PRs. Closed pull requests are easy to recreate, and little work is lost by closing a pull request that subsequently needs to be reopened.
44-
45-
We want to limit the total number of PRs in flight to:
46-
* Maintain a clean project
47-
* Remove old PRs that would be difficult to rebase as the underlying code has changed over time
48-
* Encourage code velocity
37+
An overview of how pull requests are managed for kubernetes. This document
38+
assumes the reader has already followed the [development guide](development.md)
39+
to set up their environment.
4940

5041
Life of a Pull Request
5142
----------------------
5243

53-
### Visual overview
54-
55-
![PR workflow](pr_workflow.png)
56-
5744
Unless in the last few weeks of a milestone when we need to reduce churn and stabilize, we aim to be always accepting pull requests.
5845

5946
Either the [on call](https://github.com/kubernetes/kubernetes/wiki/Kubernetes-on-call-rotations) manually or the [github "munger"](https://github.com/kubernetes/contrib/tree/master/mungegithub) submit-queue plugin automatically will manage merging PRs.
6047

6148
There are several requirements for the submit-queue to work:
6249
* Author must have signed CLA ("cla: yes" label added to PR)
6350
* No changes can be made since last lgtm label was applied
64-
* k8s-bot must have reported the GCE E2E build and test steps passed (Travis, Shippable and Jenkins build)
51+
* k8s-bot must have reported the GCE E2E build and test steps passed (Travis, Jenkins unit/integration, Jenkins e2e)
6552

6653
Additionally, for infrequent or new contributors, we require the on call to apply the "ok-to-merge" label manually. This is gated by the [whitelist](https://github.com/kubernetes/contrib/blob/master/mungegithub/whitelist.txt).
6754

55+
### Before sending a pull request
56+
57+
The following will save time for both you and your reviewer:
58+
59+
* Enable [pre-commit hooks](development.md#committing-changes-to-your-fork) and verify they pass.
60+
* Verify `hack/verify-generated-docs.sh` passes.
61+
* Verify `hack/test-go.sh` passes.
62+
63+
### Visual overview
64+
65+
![PR workflow](pr_workflow.png)
66+
67+
Other notes
68+
-----------
69+
70+
Pull requests that are purely support questions will be closed and
71+
redirected to [stackoverflow](http://stackoverflow.com/questions/tagged/kubernetes).
72+
We do this to consolidate help/support questions into a single channel,
73+
improve efficiency in responding to requests and make FAQs easier
74+
to find.
75+
76+
Pull requests older than 2 weeks will be closed. Exceptions can be made
77+
for PRs that have active review comments, or that are awaiting other dependent PRs.
78+
Closed pull requests are easy to recreate, and little work is lost by closing a pull
79+
request that subsequently needs to be reopened. We want to limit the total number of PRs in flight to:
80+
* Maintain a clean project
81+
* Remove old PRs that would be difficult to rebase as the underlying code has changed over time
82+
* Encourage code velocity
83+
84+
6885
Automation
6986
----------
7087

0 commit comments

Comments
 (0)