diff options
| author | Jesse Duffield <jessedduffield@gmail.com> | 2022-10-09 08:49:49 -0700 |
|---|---|---|
| committer | Jesse Duffield <jessedduffield@gmail.com> | 2022-10-09 08:49:49 -0700 |
| commit | 24a07ae85ab235f3fa47c0b1665c4a6db578c05b (patch) | |
| tree | 6794b8e2e7d4282a99e02bb5600d04f40e63e729 /CONTRIBUTING.md | |
| parent | c370a5e728116096228da84593a7179631ceed84 (diff) | |
update docs for lazycore
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4de86725f..38bc30eda 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,7 +140,7 @@ Lazygit has two kinds of tests: unit tests and integration tests. Unit tests go Sometimes you will need to make a change in the gocui fork (https://github.com/jesseduffield/gocui). Gocui is the package responsible for rendering 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 +1. Make the changes in gocui inside lazygit's 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: @@ -151,6 +151,21 @@ Sometimes you will need to make a change in the gocui fork (https://github.com/j 5. Raise a PR in lazygit with those changes +## Updating Lazycore + +[Lazycore](https://github.com/jesseduffield/lazycore) is a repo containing shared functionality between lazygit and lazydocker. Sometimes you will need to make a change to that repo and import the changes into lazygit. Similar to updating Gocui, here's what you do: + +1. Make the changes in lazycore inside lazygit's vendor directory so it's easy to test against lazygit +2. Copy the changes over to the actual lazycore repo (clone it if you haven't already, and use the `master` branch) +3. Raise a PR on the lazycore repo with your changes +4. After that PR is merged, make a PR in lazygit bumping the lazycore version. You can bump the version by running the following at the lazygit repo root: + +```sh +./scripts/bump_lazycore.sh +``` + +5. Raise a PR in lazygit with those changes + ## Improvements If you can think of any way to improve these docs let us know. |