Contributing to Browbeat

Contributions are most welcome! To get started you must first create a
Launchpad account and follow the instructions here to get started as a new OpenStack contributor.

Once you’ve signed the contributor license agreement and read through the above documentation, add your public SSH key under the ‘SSH Public Keys’ section of review.openstack.org.

You can view your public key using:

$ cat ~/.ssh/id_\{r or d\}sa.pub

Set your username and email for review.openstack.org:

$ git config --global user.email "example@example.com"
$ git config --global user.name "example"
$ git config --global --add gitreview.username "example"

Next, Clone the github repository:

$ git clone https://github.com/openstack/browbeat.git

You need to have git-review in order to be able to submit patches using
the gerrit code review system. You can install it using:

$ yum install git-review

To set up your cloned repository to work with OpenStack Gerrit

[user@laptop browbeat]$ git review -s

Make your changes and then commit them. Use:

[user@laptop browbeat]$ git review

If you want to edit an already submitted patch, follow the below series
of steps:

Firstly, go to the browbeat directory. Then,

git review -d Change-Id

Change-Id is the change id number as seen on gerrithub.io.

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

$git reset --hard commit-number

Then,

$ git fetch origin

$ git rebase origin/master

Make the changes on the branch that was setup by using the git review -d
(the name of the branch is along the lines of
review/username/branch_name/patchsetnumber).

Add the files to git and commit your changes using,

$ git commit --amend

You can edit your commit message as well in the prompt shown upon
executing above command.

Finally, push the patch for review using,

$ git review