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

Standardize Error Handling Across the Project #37

Open
4 tasks
petermsouzajr opened this issue Jan 3, 2024 · 0 comments
Open
4 tasks

Standardize Error Handling Across the Project #37

petermsouzajr opened this issue Jan 3, 2024 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed READY: comment '.take' to claim This issue is ready to claim, comment keyword .take and you will be assigned to this issue

Comments

@petermsouzajr
Copy link
Owner

Issue

The current codebase exhibits inconsistent error handling practices. In various instances, errors are thrown using ThrowNew Error, ThrowError, or simply logged to the console with messages for the user. This inconsistency can lead to confusion and make the code harder to maintain and debug.

Expected Behavior

Error handling should be standardized across the entire project. We should decide on a consistent method for throwing errors and displaying messages to users.

Tasks

  • Review all instances of error handling in the codebase.
  • Replace ThrowNew Error and ThrowError with a standardized error-throwing mechanism.
  • Remove any user-facing error logs that are meant for debugging purposes.
  • Document the standard error handling procedure in the CONTRIBUTING guidelines.

Impact

Addressing this issue will improve code maintainability, provide clearer debugging messages during development, and enhance the user experience by providing consistent and informative error messages.

Seeking Contributors

Anyone who would like to contribute to this standardization effort is welcome. This is a good first issue for newcomers to the project who are familiar with best practices in error handling.

@petermsouzajr petermsouzajr added help wanted Extra attention is needed good first issue Good for newcomers labels Jan 3, 2024
@petermsouzajr petermsouzajr added READY: comment '.take' to claim This issue is ready to claim, comment keyword .take and you will be assigned to this issue ready and removed ready labels Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed READY: comment '.take' to claim This issue is ready to claim, comment keyword .take and you will be assigned to this issue
Projects
None yet
Development

No branches or pull requests

1 participant