From fcdb1fbfa1e691bbdfb73a289ff84fbf6b26fad6 Mon Sep 17 00:00:00 2001 From: Raghuram Devarakonda Date: Wed, 15 Apr 2015 17:11:58 -0400 Subject: [PATCH] Improve documentation in "project" directory. Signed-off-by: Raghuram Devarakonda --- docs/sources/project/advanced-contributing.md | 2 +- docs/sources/project/coding-style.md | 4 +- docs/sources/project/create-pr.md | 30 +++++---- docs/sources/project/find-an-issue.md | 16 ++--- docs/sources/project/set-up-git.md | 4 +- docs/sources/project/software-required.md | 2 +- docs/sources/project/work-issue.md | 66 ++++++++----------- 7 files changed, 58 insertions(+), 66 deletions(-) diff --git a/docs/sources/project/advanced-contributing.md b/docs/sources/project/advanced-contributing.md index 0c9b5d1ce8..ee958f4b47 100644 --- a/docs/sources/project/advanced-contributing.md +++ b/docs/sources/project/advanced-contributing.md @@ -89,7 +89,7 @@ The following provides greater detail on the process: This is a Markdown file that describes your idea. Your proposal should include information like: - * Why is this changed needed or what are the use cases? + * Why is this change needed or what are the use cases? * What are the requirements this change should meet? * What are some ways to design/implement this feature? * Which design/implementation do you think is best and why? diff --git a/docs/sources/project/coding-style.md b/docs/sources/project/coding-style.md index e5b6f5fe9c..bf8267e716 100644 --- a/docs/sources/project/coding-style.md +++ b/docs/sources/project/coding-style.md @@ -6,8 +6,8 @@ page_keywords: change, commit, squash, request, pull request, test, unit test, i This checklist summarizes the material you experienced working through [make a code contribution](/project/make-a-contribution) and [advanced -contributing](/project/advanced-contributing). The checklist applies to code -that is program code or code that is documentation code. +contributing](/project/advanced-contributing). The checklist applies to both +program code and documentation code. ## Change and commit code diff --git a/docs/sources/project/create-pr.md b/docs/sources/project/create-pr.md index 197aee849d..f39f0aa98a 100644 --- a/docs/sources/project/create-pr.md +++ b/docs/sources/project/create-pr.md @@ -22,7 +22,7 @@ Before you create a pull request, check your work. 2. Checkout your feature branch. $ git checkout 11038-fix-rhel-link - Already on '11038-fix-rhel-link' + Switched to branch '11038-fix-rhel-link' 3. Run the full test suite on your branch. @@ -41,7 +41,11 @@ Before you create a pull request, check your work. Always rebase and squash your commits before making a pull request. -1. Fetch any of the last minute changes from `docker/docker`. +1. Checkout your feature branch in your local `docker-fork` repository. + + This is the branch associated with your request. + +2. Fetch any last minute changes from `docker/docker`. $ git fetch upstream master From github.com:docker/docker @@ -56,28 +60,28 @@ Always rebase and squash your commits before making a pull request. pick 1a79f55 Tweak some of the other text for grammar pick 53e4983 Fix a link pick 3ce07bb Add a new line about RHEL - - If you run into trouble, `git --rebase abort` removes any changes and gets - you back to where you started. -4. Squash the `pick` keyword with `squash` on all but the first commit. +5. Replace the `pick` keyword with `squash` on all but the first commit. pick 1a79f55 Tweak some of the other text for grammar squash 53e4983 Fix a link squash 3ce07bb Add a new line about RHEL - After closing the file, `git` opens your editor again to edit the commit - message. + After you save the changes and quit from the editor, git starts + the rebase, reporting the progress along the way. Sometimes + your changes can conflict with the work of others. If git + encounters a conflict, it stops the rebase, and prints guidance + for how to correct the conflict. -5. Edit and save your commit message. +6. Edit and save your commit message. `git commit -s` Make sure your message includes FETCH_HEAD -3. Fetch all the changes from the `upstream master` branch. +3. Start an interactive rebase. - $ git fetch upstream master + $ git rebase -i upstream/master - This command says get all the changes from the `master` branch belonging to - the `upstream` remote. +4. Rebase opens an editor with a list of commits. -4. Rebase your master with the local copy of Docker's `master` branch. + pick 1a79f55 Tweak some of the other text for grammar + pick 53e4983 Fix a link + pick 3ce07bb Add a new line about RHEL - $ git rebase -i upstream/master - - This command starts an interactive rebase to rewrite all the commits from - Docker's `upstream/master` onto your local branch, and then re-apply each of - your commits on top of the upstream changes. If you aren't familiar or - comfortable with rebase, you can learn more about rebasing on the web. - -5. Rebase opens an editor with a list of commits. +5. Replace the `pick` keyword with `squash` on all but the first commit. - pick 1a79f55 Tweak some of the other text for grammar - pick 53e4983 Fix a link - pick 3ce07bb Add a new line about RHEL - - If you run into trouble, `git --rebase abort` removes any changes and gets - you back to where you started. + pick 1a79f55 Tweak some of the other text for grammar + squash 53e4983 Fix a link + squash 3ce07bb Add a new line about RHEL -6. Squash the `pick` keyword with `squash` on all but the first commit. + After you save the changes and quit from the editor, git starts + the rebase, reporting the progress along the way. Sometimes + your changes can conflict with the work of others. If git + encounters a conflict, it stops the rebase, and prints guidance + for how to correct the conflict. - pick 1a79f55 Tweak some of the other text for grammar - squash 53e4983 Fix a link - squash 3ce07bb Add a new line about RHEL +6. Edit and save your commit message. - After closing the file, `git` opens your editor again to edit the commit - message. + `git commit -s` -7. Edit the commit message to reflect the entire change. + Make sure your message includes