feat(devex): add self-documenting make help target#6568
Open
Ayushmore1214 wants to merge 1 commit intopipe-cd:masterfrom
Open
feat(devex): add self-documenting make help target#6568Ayushmore1214 wants to merge 1 commit intopipe-cd:masterfrom
Ayushmore1214 wants to merge 1 commit intopipe-cd:masterfrom
Conversation
To make onboarding and local testing smoother for everyone, I added a self-documenting make help target to the Makefile. Instead of digging through the file to figure out how to spin up the local environment, contributors can now just run make help to get a clean, formatted CLI menu of all the primary commands (build, test, local cluster setup, linters) and what they do. Signed-off-by: Ayush More <ayushmore42595@gmail.com>
Contributor
Author
|
@eeshaanSA @khanhtc1202 plz take a look! |
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
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.
To make onboarding and local testing smoother for everyone, I added a self-documenting make help target to the Makefile.
Instead of digging through the file to figure out how to spin up the local environment, contributors can now just run make help to get a clean, formatted CLI menu of all the primary commands (build, test, local cluster setup, linters) and what they do.
What this PR does:
Why we need it:
Which issue(s) this PR fixes:
Fixes #
Does this PR introduce a user-facing change?: