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

Use consistent capitalization in error messages #1092

Open
AObuchow opened this issue Apr 24, 2023 · 2 comments
Open

Use consistent capitalization in error messages #1092

AObuchow opened this issue Apr 24, 2023 · 2 comments
Labels

Comments

@AObuchow
Copy link
Collaborator

#1064 refactored the way errors were propagated in the devworkspace-controller, and highlighted the fact that some error messages in DWO start with a lower case letter while others start with a capital letter.

It would be nice to make the capitalization of error messages consistent, as they can be shown to the user in cases where the workspace startup fails.

Some things to consider:

  • Do we want DW error & warning status messages to always start with a lower case letter, or upper case?
  • Some error messages get concatenated with another error message to provide some context, so it's not just a matter of changing all error messages to start with an upper or lower case letter.
    • Maybe the functions set the workspace status messages (e.g. this one for failing workspaces) should automatically capitalize the first letter of the workspace status message. This way, we could more easily enforce the standard of all error messages starting with a lowercase letter while ensuring user-facing error messages start with an uppercase letter.
@Horiodino
Copy link

hey @AObuchow If no one else is currently working on this issue, I would like to take it on. Please let me know if it's available for me to handle.

@AObuchow
Copy link
Collaborator Author

AObuchow commented Jun 8, 2024

@Horiodino no one is currently working on this issue, I'd be happy to have you work on it :)

Horiodino added a commit to Horiodino/devworkspace-operator that referenced this issue Aug 23, 2024
Fix devfile#1092

Signed-off-by: Horiodino <holiodin@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants