summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAnthony Wilson <wilsonan@us.ibm.com>2018-12-07 00:49:09 -0600
committerGunnar Mills <gmills@us.ibm.com>2019-01-07 15:47:38 +0000
commit8eda385eb62646cb00e4c3af278e23456832cec3 (patch)
treeb7ba846dbf1bc595b4da89a27454f1ab641738ed
parentf7d170d3112de39eb85a17b58e7b9b0c9344df0d (diff)
downloadopenbmc-docs-8eda385eb62646cb00e4c3af278e23456832cec3.tar.gz
openbmc-docs-8eda385eb62646cb00e4c3af278e23456832cec3.zip
gerrit-setup: Add section on pushing to Gerrit
While not directly associated with the setup of Gerrit, this will give a new user an end to end idea of the Gerrit code review workflow. Change-Id: If0194939bd5205d8af129d53b59f40e396f1eeda Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>
-rw-r--r--development/gerrit-setup.md24
1 files changed, 22 insertions, 2 deletions
diff --git a/development/gerrit-setup.md b/development/gerrit-setup.md
index 6d32cc4..6f44471 100644
--- a/development/gerrit-setup.md
+++ b/development/gerrit-setup.md
@@ -68,6 +68,26 @@ scp -p -P 29418 openbmc.gerrit:hooks/commit-msg ${gitdir}/hooks
This will enhance the `git commit` command to add a `Change-Id` to your commit
message which Gerrit uses to track the review.
+##### Push Code Change to Gerrit
+Now that your workstation and Gerrit are configured, you are ready to make code
+changes and push them to Gerrit for code review. Here is what the basic workflow
+will look like.
+* Make your code changes
+* Add those files to the index to be committed:
+ `git add [file1 file2 ... fileN]`
+* Commit your changes, adding a Signed-off-by line to it (more on
+ [writing good commit messages](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md#submitting-changes)):
+ `git commit --signoff`
+* Push your changes to Gerrit for code review:
+ `git push HEAD:refs/for/master`
+* Go to [Gerrit web interface](https://gerrit.openbmc-project.xyz/), click on
+ your new review, and add reviewers based on `MAINTAINERS` file in the repo.
+
##### Conclusion
-If you've completed all of the above steps successfully, that's it! You are now
-set up to push your changes up to Gerrit for code review!
+If you've completed all of the above steps successfully, that's it! You have now
+set up Gerrit and know how to submit your code changes for review!
+
+Submitting changes for review is just one of many steps in the contributing
+process. Please see
+[CONTRIBUTING](https://github.com/openbmc/docs/blob/master/CONTRIBUTING.md)
+for best practices.
OpenPOWER on IntegriCloud