docs: Add a note about synchronizing the branch.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/4e8a91e3 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/4e8a91e3 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/4e8a91e3 Branch: refs/heads/trunk Commit: 4e8a91e337ea601820a17a2eca6b316462b44a73 Parents: df13c7a Author: Tomaz Muraus <[email protected]> Authored: Fri Dec 27 15:52:24 2013 +0100 Committer: Tomaz Muraus <[email protected]> Committed: Fri Dec 27 15:52:24 2013 +0100 ---------------------------------------------------------------------- docs/development.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/4e8a91e3/docs/development.rst ---------------------------------------------------------------------- diff --git a/docs/development.rst b/docs/development.rst index 504380c..fac8238 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -256,7 +256,7 @@ pull request description contains link to the JIRA ticket. Wait for your changes to be reviewed and address any outstanding comments. -10. Squash the committs and generate the patch +10. Squash the commits and generate the patch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Once the changes has been reviewed, all the outstanding issues have been @@ -270,7 +270,11 @@ the commits (if necessary) and generate a patch. Make sure to use ``git format-patch`` and not ``git diff`` so we can preserve the commit authorship. -Note: If you have never used rebase and squashed the commits before, you can +Note #1: Before you generate the patch and squash the commits, make sure to +synchronize your branch with the latest trunk (run ``git pull upstream trunk`` +in your branch), otherwise we might have problems applying it cleanly. + +Note #2: If you have never used rebase and squashed the commits before, you can find instructions on how to do that in the following guide: `squashing commits with rebase`_.
