Emphasize that a branch/PR should have closely-related changes.

This is the result of a discussion on how to make cherry-picking easier for the One That Merges during the 2015-12-07 (or -08, depending on your time zone) OpenShift writers' meeting.
gyj0825 · Dec 10, 2015 · 98c62ae · 98c62ae
1 parent 7e95923
commit 98c62ae
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/contributing_to_docs/contributing.adoc b/contributing_to_docs/contributing.adoc
@@ -15,7 +15,11 @@ There are a few different ways you can contribute to OpenShift documentation:
 * https://github.com/openshift/openshift-docs/issues/new[Create an issue in
 GitHub]
 * If you would like to do the work yourself, or if it is a substantial change,
-then you you should clone the repository, make your changes, and submit a PR
+then you you should clone the repository, make your changes, and submit a PR.
+Each PR should have closely-related changes.
+In particular, it is a good idea to use separate PRs
+for bugfix changes (for an old or current release)
+vs enhancement changes (for an upcoming new release).
 
 *What happens when you submit a PR?*
 

diff --git a/contributing_to_docs/create_or_edit_content.adoc b/contributing_to_docs/create_or_edit_content.adoc
@@ -59,6 +59,11 @@ any new content.
 
 The following command creates a new local branch and checks it out
 automatically. Be sure to replace `<working_branch>` with a suitable name.
+Also, be sure that the changes made on this branch are closely related and
+do indeed reflect that name.
+In particular, it is a good idea to use separate PRs
+for bugfix changes (for an old or current release)
+vs enhancement changes (for an upcoming new release).
 
 ----
 $ git checkout -b <working_branch>