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

Error handling optimization for aptos-cli, aptos-client, aptos-common, create-dubhe #95

Open
5 tasks
Zombieliu opened this issue Dec 5, 2024 · 0 comments
Assignees
Labels
aptos aptos cli cli difficulty:medium difficulty:medium example example frontend frontend good first issue Good for newcomers move move non-rewarded non-rewarded ODHack 11 from onlydust open for contribution open for contribution sdk sdk tutorials tutorials

Comments

@Zombieliu
Copy link
Contributor

Objective

Optimize the error handling mechanism of the aptos-cli, aptos-client, aptos-common, and create-dubhe modules to provide clearer and more consistent error return formats, enhancing the developer experience.

Implementation Steps

  1. Review existing error handling methods:

    • Audit current error handling logic.
    • Identify common error types.
    • Count inconsistencies in error return formats.
  2. Design a unified error handling scheme:

    • Define a standard error code system.
    • Design error message templates.
    • Standardize the display of error stack information.
  3. Implement error handling optimization:

    • Unify error output format in aptos-cli.
    • Standardize error returns in aptos-client.
    • Optimize error handling in aptos-common.
    • Update error handling examples in the create-dubhe template.
  4. Improve error documentation:

    • Write error code documentation.
    • Provide best practice guides for error handling.
    • Update related API documentation.

Acceptance Criteria

  • All modules implement a unified error handling mechanism.
  • Error messages are clear and understandable, containing necessary context information.
  • Provide complete error code documentation.
  • Error return format complies with REST API best practices.
  • The new error handling mechanism is backward compatible.
@Zombieliu Zombieliu added difficulty:medium difficulty:medium frontend frontend example example tutorials tutorials aptos aptos sdk sdk cli cli move move labels Dec 5, 2024
@Zombieliu Zombieliu added good first issue Good for newcomers ODHack 11 from onlydust open for contribution open for contribution non-rewarded non-rewarded labels Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
aptos aptos cli cli difficulty:medium difficulty:medium example example frontend frontend good first issue Good for newcomers move move non-rewarded non-rewarded ODHack 11 from onlydust open for contribution open for contribution sdk sdk tutorials tutorials
Projects
None yet
Development

No branches or pull requests

3 participants