Browse Source

Adding review board info to CONTRIBUTING.md

Dan Ballard 1 year ago
parent
commit
68556bb4fc
1 changed files with 29 additions and 3 deletions
  1. 29 3
      CONTRIBUTING.md

+ 29 - 3
CONTRIBUTING.md

@@ -1,3 +1,7 @@
+# Contributing
+
+## Getting Started
+
 Sign up to the [Open Privacy Gogs instance](https://git.openprivacy.ca/)
 
 Get the code
@@ -10,6 +14,8 @@ Make a development branch to do your work
     
 If you are using Goland as an IDE, now would be a good time to enable automatic gofmt on save of files with the File Watches plugin [https://stackoverflow.com/questions/33774950/execute-gofmt-on-file-save-in-intellij](StackOverflow)
 
+## Pull Requests
+
 When you are done, rebase squash any multiple commits you have into one
 
     git rebase -i master
@@ -19,7 +25,7 @@ Test the code and check it has not quality issues
     ./testing/tests.sh
     ./testing/quality.sh
     
-Ideally run the ingegration tests (~5 minutes)
+Ideally run the integration tests (~5 minutes)
 
     cd testing
     go test
@@ -30,7 +36,27 @@ push your branch (-f for *force* in the case you've rebased and squashed)
     
 create a [pull request](https://git.openprivacy.ca/cwtch.im/cwtch/pulls)
 
-If you have fixes, you can ammend them to the current commit rather than a new one with
+If you have fixes, you can amend them to the current commit rather than a new one with
 
-    git commit --ammend
+    git commit --amend
     git push -f
+
+## Review Board
+
+For very large and complicated Pull Requests we have created a Review Board instance to facilitate more in depth review and discussion at https://review.openprivacy.ca
+
+First acquire the client, RBTools, on Ubuntu:
+
+    apt install rbtools
+
+Then hookup your git repo to review board with:    
+
+    rbt setup-repo
+
+Using the repo `cwtch`
+
+Finally you will be able to create commits with
+
+    rbt post --parent master
+
+It possibly will need the arguments `--tracking-branch=cwtch/master --branch=YOUR-BRANCH -d` (-d for debug if you are having trouble)