From 86bb73cff1acf0d6e2ec6e0ed8b70010fb57f06c Mon Sep 17 00:00:00 2001 From: Jesse Duffield Date: Thu, 5 Oct 2023 18:21:14 +1100 Subject: [PATCH] Better Explain the red/yellow/green commit colouring --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 62153bf12..a4b47a31d 100644 --- a/README.md +++ b/README.md @@ -478,9 +478,13 @@ If you would like to support the development of lazygit, consider [sponsoring me ### What do the commit colors represent? -- Green: the commit is included in the master branch -- Yellow: the commit is not included in the master branch -- Red: the commit has not been pushed to the upstream branch +- Green: the commit is included in the main branch's upstream +- Yellow: the commit is not included in the main branch's upstream +- Red: the commit has not been pushed to the given branch's upstream + +By 'main' branch we mean any branch defined in the `git.mainBranches` config which defaults to 'master' and 'main'. We check against the upstream and if that's missing we fall back to checking against the local branch itself. We prioritise the upstream because it's typically more up-to-date. + +This colouring scheme lets you see at a glance which commits belong to your branch, and which commits belong to the main branch. ## Shameless Plug