[doc/ug] Github commit & merge guide
Now the repo only supports `Rebase and Merge` option, the doc is revised
to explain how to pack commits into a commit. Also, added guideline of
commit message while squashing.
diff --git a/doc/ug/github_notes.md b/doc/ug/github_notes.md
index c9815cb..6d20f04 100644
--- a/doc/ug/github_notes.md
+++ b/doc/ug/github_notes.md
@@ -112,6 +112,9 @@
the change. If you are fixing an issue then add a line at the end of
the message `Fixes #nn` where `nn` is the issue number. This will link
the fix and close out the issue when it is added to the lowRISC repo.
+If the change is an attempted fix that has not yet had confirmation from
+verification engineers, it should not close the related issue. In this case,
+write `Related to #nn` in the commit message rather than `Fixes #nn`.
When you have finished everything locally (it is good practice to do a
status check to ensure things are clean) you can push your branch (eg
@@ -141,7 +144,7 @@
$ git push -f origin forchange
```
-Once the reviewers are happy you can "Squash and merge" the Pull
+Once the reviewers are happy you can "Rebase and Merge" the Pull
Request on GitHub, delete the branch there (it offers to do this when
you do the merge). You can delete the branch in your local repo with:
@@ -150,6 +153,23 @@
$ git branch -D forchange
```
+When a Pull Request contain multiple commits, those commits should be logically
+independent. Interactive rebase can be used to manipulate commits in a pull
+request to achieve that goal. Commonly, it might be used to squash commits that
+fix up issues reported during review back into the relevant commit.
+
+```console
+$ git rebase -i `git merge-base {current_branch} master`
+```
+
+Then, an editor will open. Follow the instructions given there, to reorder and
+combine commits, or to change the commit message. Then update the PR branch in
+the Github remote repository.
+
+```console
+$ git push -f origin HEAD
+```
+
## Update your repo with changes in the lowRISC repo
There is a little work to do to keep everything in sync. Normally you
