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

Define a CLI style guide #4896

Open
zanieb opened this issue Jul 8, 2024 · 0 comments
Open

Define a CLI style guide #4896

zanieb opened this issue Jul 8, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation internal A refactor or improvement that is not user-facing

Comments

@zanieb
Copy link
Member

zanieb commented Jul 8, 2024

We should determine and document our preferred styling for CLI output so we can be consistent.

Content may include:

  • Use of backticks (`)
  • Use of colons (:)
  • Use bolding and dimming
  • Capitalization
  • Preferred terminology
  • Meaning of colors
  • When progress bars are needed
  • When lines should be ephemeral
  • If messages should be tracing logs or written directly
  • When stderr or stdout should be used
  • Error message styling
  • When capitalization should be used in error/log messages
@zanieb zanieb added documentation Improvements or additions to documentation internal A refactor or improvement that is not user-facing labels Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal A refactor or improvement that is not user-facing
Projects
None yet
Development

No branches or pull requests

1 participant