Guide and Blog Post for better Error messages
Open
@joshuahannan is already working on this.
Since Sep 3, 2024.
documentation
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.