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

Enhance Error Messages #577

Open
dylanpulver opened this issue Aug 14, 2024 · 6 comments
Open

Enhance Error Messages #577

dylanpulver opened this issue Aug 14, 2024 · 6 comments
Labels
good first issue Highlights issues that are suitable for first-time contributors.

Comments

@dylanpulver
Copy link
Collaborator

dylanpulver commented Aug 14, 2024

Clear and informative error messages are essential for a good user experience. We are looking for contributions that improve existing error messages, making them more descriptive and helpful for users. If you improve an error message, please create a new issue to describe the enhancements you’ve made and link it back to this general error message improvement issue.

Copy link

Hi @dylanpulver, thank you for opening this issue!

We appreciate your effort in reporting this. Our team will review it and get back to you soon.
If you have any additional details or updates, feel free to add them to this issue.

Note: If this is a serious security issue that could impact the security of Safety CLI users, please email [email protected] immediately.

Thank you for contributing to Safety CLI!

@dylanpulver dylanpulver added the good first issue Highlights issues that are suitable for first-time contributors. label Aug 14, 2024
@rpattekar
Copy link

take

@rpattekar
Copy link

rpattekar commented Aug 15, 2024

@dylanpulver Can someone please point out to me one error message that would be a good candidate for enhancing? Just so I have an idea of what to look for...

@dylanpulver
Copy link
Collaborator Author

Hi @rpattekar, Absolutely!

For this one we welcome updates to existing error messages as well as introducing new error messages to the codebase.

I will post a few approaches here.

  1. searching LOG.exception in the codebase
    We have 20 results here which can likely be improved upon!:
image
  1. searching try
    We have ~100 try except loops but not all except blocks have logging currently.
image
  1. searching LOG.error
    We have 8 cases of LOG.error in the codebase that could likely be improved!
image

These are just starting places/ideas to consider for improving existing logging and adding more logging. We welcome any ideas to improve our error messages across the codebase! Thank you!

@vgauraha62
Copy link

its a good idea to improve log statements in the code, can you please help me locate the console messages for this?

@dylanpulver
Copy link
Collaborator Author

@vgauraha62 Definitely! In my message above I listed a few areas where log statements either exist or should be added. Is there anything else I can help to provide?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Highlights issues that are suitable for first-time contributors.
Projects
None yet
Development

No branches or pull requests

3 participants