x/browbeat
Code Issues Proposed changes

README.rst cleanup/additions

Browse Source 
+ Add instructions to create a separate branch when working on
patches, this is generally best practice.
+ Change quoted commands to use "$ commandhere" everywhere to be
more consistent

Patchset #2: move commit message description instructions in a
more appropriate place

You can view the proposed changes here:
http://rst.ninjs.org/?n=0274181d796ce3c52c57c473635a3843&theme=basic

Change-Id: I76a4fe73ed001e7927e4d10c30d2d872c09b2268
This commit is contained in:
Will Foster 2016-06-15 17:40:03 +01:00
parent 6b22d67596
commit 396a51d77c
1 changed files with 46 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.rst
View File

@ -283,39 +283,71 @@ the gerrit code review system. You can install it using:
::
$ yum install git-review
$ sudo yum install git-review
To set up your cloned repository to work with OpenStack Gerrit
::
[user@laptop browbeat]$ git review -s
$ git review -s
Make your changes and then commit them. Use:
It's useful to create a branch to do your work, name it something
related to the change you'd like to introduce.
::
[user@laptop browbeat]$ git review
$ cd browbeat
$ git branch my_special_enhancement
$ git checkout !$
If you want to edit an already submitted patch, follow the below series
of steps:
Firstly, go to the browbeat directory. Then,
Make your changes and then commit them using the instructions
below.
::
git review -d Change-Id
$ git add /path/to/files/changed
$ git commit
Change-Id is the change id number as seen on gerrithub.io.
Use a descriptive commit title followed by an empty space.
You should type a small justification of what you are
changing and why.
Now you're ready to submit your changes for review:
::
$ git review
If you want to make another patchset from the same commit you can
use the ammend feature after further modification and saving.
::
$ git add /path/to/files/changed
$ git commit --amend
$ git review
If you want to submit a new patchset from a different location
(perhaps on a different machine or computer for example) you can
clone the browbeat repo again (if it doesn't already exist) and then
use git review against your unique Change-ID:
::
$ git review -d Change-Id
Change-Id is the change id number as seen in Gerrit and will be
generated after your first successful submission.
The above command downloads your patch onto a seperate branch. You might
need to rebase your local branch with remoste master before running the
abovecommand to avoid merge conflicts when you resubmit your edited
patch. To avoid this, Go back to a "safe" commit using
need to rebase your local branch with remote master before running it to
avoid merge conflicts when you resubmit the edited patch. To avoid this
go back to a "safe" commit using:
::
$git reset --hard commit-number
$ git reset --hard commit-number
Then,