Reorganize and rename packages for improved cognitive load #379
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Packages in Go should generally be singular in name. So the pkg `controllers` was renamed to `controller`. The 2 controllers, tinkerbellcluster and tinkerbellmachine were put into their own packages. This was done to help improve the cognitive load for understanding and maintaining this repo. Additional files in the machine package were created to also help with the cognitive load of that controller. Signed-off-by: Jacob Weinstock <[email protected]>
Clean up missed from the reorg. Signed-off-by: Jacob Weinstock <[email protected]>
Signed-off-by: Jacob Weinstock <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Packages in Go should generally be singular in name. So the pkg
controllerswas renamed tocontroller. The 2 controllers,tinkerbellclusterandtinkerbellmachinewere put into their own packages. This was done to help improve the cognitive load for understanding and maintaining this repo.Additional files in the machine package were created to also help with the cognitive load of that controller.
Note
No functionality has been changed.
Why is this needed
Fixes: #
How Has This Been Tested?
How are existing users impacted? What migration steps/scripts do we need?
Checklist:
I have: