diff --git a/docs/devel/pull-requests.md b/docs/devel/pull-requests.md index f4e63f89ab2..de2c6bd7d8e 100644 --- a/docs/devel/pull-requests.md +++ b/docs/devel/pull-requests.md @@ -31,15 +31,26 @@ Documentation for other releases can be found at -Pull Request Process -==================== + + + +- [Pull Request Process](#pull-request-process) +- [Life of a Pull Request](#life-of-a-pull-request) + - [Before sending a pull request](#before-sending-a-pull-request) + - [Release Notes](#release-notes) + - [Visual overview](#visual-overview) +- [Other notes](#other-notes) +- [Automation](#automation) + + + +# Pull Request Process An overview of how pull requests are managed for kubernetes. This document assumes the reader has already followed the [development guide](development.md) to set up their environment. -Life of a Pull Request ----------------------- +# Life of a Pull Request 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. @@ -52,7 +63,7 @@ There are several requirements for the submit-queue to work: 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). -### Before sending a pull request +## Before sending a pull request The following will save time for both you and your reviewer: @@ -60,12 +71,24 @@ The following will save time for both you and your reviewer: * Verify `hack/verify-generated-docs.sh` passes. * Verify `hack/test-go.sh` passes. -### Visual overview +## Release Notes + +All pull requests are initiated with a `needs-release-note` label. +There are many `release-note-*` label options, including `release-note-none`. +If your PR does not require any visibility at release time, you may use a +`release-note-none` label. Otherwise, please choose a `release-note-*` label +that fits your PR. + +Additionally, `release-note-none` is not allowed on PRs on release branches. + +Finally, ensure your PR title is the release note you want published at relase +time. + +## Visual overview ![PR workflow](pr_workflow.png) -Other notes ------------ +# Other notes Pull requests that are purely support questions will be closed and redirected to [stackoverflow](http://stackoverflow.com/questions/tagged/kubernetes). @@ -82,8 +105,7 @@ request that subsequently needs to be reopened. We want to limit the total numbe * Encourage code velocity -Automation ----------- +# Automation We use a variety of automation to manage pull requests. This automation is described in detail [elsewhere.](automation.md)