-
Notifications
You must be signed in to change notification settings - Fork 31
docs(maintainers): add style guide for input and output #422
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| # Style Guide | ||
|
|
||
| A current suggestion for how Slack CLI inputs are handled and outputs are formatted. | ||
|
|
||
| - **Input** | ||
| - [Prompts are Flags with Forms](#prompts-are-flags-with-forms) | ||
| - **Output** | ||
| - [Format Sections with Command Details](#format-sections-with-command-details) | ||
|
|
||
| ## Input | ||
|
|
||
| Customizations to commands are made through arguments, flags, environment variables, saved files, details from the Slack API itself, or sometimes just kept as "sensible" defaults. | ||
|
|
||
| ### Prompts are Flags with Forms | ||
|
|
||
| When information is needed we can prompt for text, confirmation, or a selection. | ||
|
|
||
| These decisions can be made in an interactive terminal (TTY) or not, such as in a scripting environment. | ||
|
|
||
| A flag option should exist for each prompt with a form fallback. Either default values should be used if forms are attempted in a non-TTY setup or an error and remmediation to use a flag should be returned. | ||
|
|
||
| ## Output | ||
|
|
||
| Results of a command go toward informing current happenings and suggesting next steps. | ||
|
|
||
| ### Format Sections with Command Details | ||
|
|
||
| A command often prints information and details about the process happenings. We format this as a section: | ||
|
|
||
| ```txt | ||
| π App Install | ||
| Installing "focused-lamb-99" app to "devrelsandbox" | ||
| Finished in 2.0s | ||
| ``` | ||
|
|
||
| This example highlights some recommendations: | ||
|
|
||
| - An emoji is used with the section header. | ||
| - The section header text is the command name, with "Title Case" letters. | ||
| - Following details reveal progress of the process. |
Oops, something went wrong.
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.
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.
praise: Awesome way to reference Claude into it.
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.
@mwbrooks Let's hope to reduce a turn or two with this π
πΎ ramble: We did consider using the
@../.github/STYLE_GUIDE.mdsyntax but didn't want to load this into context for unrelated tasks. It's an alright skill perhaps?