Skip to content
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

Merged
merged 1 commit into from
Jan 10, 2024
Merged

Add codebase guide #3206

merged 1 commit into from
Jan 10, 2024

Conversation

jesseduffield
Copy link
Owner

@jesseduffield jesseduffield commented Jan 9, 2024

  • PR Description

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.

  • Please check if the PR fulfills these requirements
  • Cheatsheets are up-to-date (run go generate ./...)
  • Code has been formatted (see here)
  • Tests have been added/updated (see here for the integration test guide)
  • Text is internationalised (see here)
  • Docs (specifically docs/Config.md) have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

Copy link

codacy-production bot commented Jan 9, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -2.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (1ca96bb) 45840 37736 82.32%
Head commit (caf6a36) 45840 (+0) 37735 (-1) 82.32% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#3206) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@jesseduffield
Copy link
Owner Author

Your AI docs link inspired this @mark2185

@jesseduffield jesseduffield force-pushed the dev-docs branch 2 times, most recently from 834797d to 99c5c98 Compare January 9, 2024 03:46
* `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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keybindingd should be keybindings

@jesseduffield
Copy link
Owner Author

This is fairly innocuous so I'm gonna merge it now and if anybody wants to post-merge review, feel free

@jesseduffield jesseduffield merged commit 498092a into master Jan 10, 2024
17 checks passed
@jesseduffield jesseduffield deleted the dev-docs branch January 10, 2024 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants