-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add codebase guide #3206
Add codebase guide #3206
Conversation
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferencesYou may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation |
Your AI docs link inspired this @mark2185 |
834797d
to
99c5c98
Compare
docs/dev/Codebase_Guide.md
Outdated
* `pkg/gui/controllers`: Contains code relating to controllers. Controllers define a list of keybindings and their associated handlers. One controller can be assigned to multiple contexts, and one context can contain multiple controllers. | ||
* `pkg/gui/controllers/helpers`: Contains code that is shared between multiple controllers. | ||
* `pkg/gui/filetree`: Contains code relating to the representation of filetrees. | ||
* `pkg/gui/keybindingd`: Contains code for mapping between keybindings and their labels |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keybindingd
should be keybindings
99c5c98
to
b419a1b
Compare
This is fairly innocuous so I'm gonna merge it now and if anybody wants to post-merge review, feel free |
b419a1b
to
caf6a36
Compare
After reading through some AI-generated lazygit docs, it occurred to me that we should actually be documenting some of this stuff ourselves.
Contributors can feel free to add stuff to this guide if they think it provides useful context.
go generate ./...
)docs/Config.md
) have been updated if necessary