update docs

2 files changed, 25 insertions, 3 deletions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e59a42044..574088cb7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,14 +1,13 @@
 # Contributing
 
-
 ♥ We love pull requests from everyone !
 
-
 When contributing to this repository, please first discuss the change you wish
 to make via issue, email, or any other method with the owners of this repository
-before making a change. 
+before making a change.
 
 ## So all code changes happen through Pull Requests
+
 Pull requests are the best way to propose changes to the codebase. We actively
 welcome your pull requests:
 
@@ -21,15 +20,33 @@ welcome your pull requests:
 7. Issue that pull request!
 
 ## Code of conduct
+
 Please note by participating in this project, you agree to abide by the [code of conduct].
 
 [code of conduct]: https://github.com/jesseduffield/lazygit/blob/master/CODE-OF-CONDUCT.md
 
 ## Any contributions you make will be under the MIT Software License
+
 In short, when you submit code changes, your submissions are understood to be
 under the same [MIT License](http://choosealicense.com/licenses/mit/) that
 covers the project. Feel free to contact the maintainers if that's a concern.
 
 ## Report bugs using Github's [issues](https://github.com/jesseduffield/lazygit/issues)
+
 We use GitHub issues to track public bugs. Report a bug by [opening a new
 issue](https://github.com/jesseduffield/lazygit/issues/new); it's that easy!
+
+## Updating Gocui
+
+Sometimes you will need to make a change in the gocui fork (https://github.com/jesseduffield/gocui). Gocui is the package responsible for rending windows and handling user input. Here's the typical process to follow:
+
+1. Make the changes in gocui inside the vendor directory so it's easy to test against lazygit
+2. Copy the changes over to the actual gocui repo (clone it if you haven't already, and use the `awesome` branch, not `master`)
+3. Raise a PR on the gocui repo with your changes
+4. After that PR is merged, make a PR in lazygit bumping the gocui version. You can bump the version by running the following at the lazygit repo root:
+
+```sh
+./bump_gocui.sh
+```
+
+5. Raise a PR in lazygit with those changes
diff --git a/bump_gocui.sh b/bump_gocui.sh
new file mode 100755
index 000000000..30e565375
--- /dev/null
+++ b/bump_gocui.sh
@@ -0,0 +1,5 @@
+# Go's proxy servers are not very up-to-date so that's why we use `GOPROXY=direct`
+# We specify the `awesome` branch to avoid the default behaviour of looking for a semver tag.
+GOPROXY=direct go get -u github.com/jesseduffield/gocui@awesome && go mod vendor
+
+# Note to self if you ever want to fork a repo be sure to use this same approach: it's important to use the branch name (e.g. master)