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

Guide and Blog Post for better Error messages #884

Open
joshuahannan opened this issue Sep 3, 2024 · 0 comments
Open

Guide and Blog Post for better Error messages #884

joshuahannan opened this issue Sep 3, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@joshuahannan
Copy link
Member

joshuahannan commented Sep 3, 2024

Issue to be solved

Error messages for panics in transactions and contracts are not very helpful to end-users.
We need a guide in the docs site to show projects how to write better error messages.

Suggest A Solution

Write a guide for standard contracts, transactions, and scripts to show how to write good error messages. Error messages could contain:

  • Contract name and function name if coming from a contract
  • Description of literal error
  • Description of what high-level reason might be causing the error
  • Suggestion for fixing it

Write a blog post about it

Write an announcement for discord, forum, twitter, etc

@joshuahannan joshuahannan self-assigned this Sep 3, 2024
@joshuahannan joshuahannan changed the title Guide for better Error messages Guide and Blog Post for better Error messages Oct 8, 2024
@joshuahannan joshuahannan added the documentation Improvements or additions to documentation label Oct 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
Projects
Status: 🔖 Ready for Pickup
Development

No branches or pull requests

1 participant