RSDK-9285 - add style guide and contribution guide #4722
Merged
Conversation
This file contains 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
|
@purplenicole730 I tried to include the improvements from #4692 but please let me know if you think I missed anything here! |
purplenicole730
requested changes
Jan 16, 2025
cli/STYLEGUIDE.md
Outdated
| }, | ||
| }, | ||
| + UsageText: createUsageText("my-parent-command my-child-command", []string{requiredFlag}, true, false), | ||
| - UsageText: createUsageText("my-child-command", []string{requiredFlag, optionalFlag}, true, false), |
There was a problem hiding this comment.
technically this should be
UsageText: createUsageText("my-child-command", []string{requiredFlag, optionalFlag}, false, false),
since my-child-command doesn't have any other flags. I think it would be nice to show that change as well
| ``` | ||
| </details> | ||
|
|
||
| ## Create Usage Text With Helper Func, Only Specify Required Args |
There was a problem hiding this comment.
Could you also add a section for using the other helper function that introduces multiple accepted values? formatAcceptedValues is a function that Gloria introduced and I've since made it more generic.
purplenicole730
approved these changes
Jan 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add style guide and contributing guide to the CLI.