OpenZeppelin / OpenZeppelin/openzeppelin-upgrades
Document debug mode
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 658
- Forks
- 286
- PR merge metrics
- No merged PRs in 30d
Description
Users can obtain more information about errors if they run using env DEBUG='*' .... In particular, this reveals transaction hashes which can be very useful information.
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.
Research direction
Start by locating the project's user-facing documentation for running commands with DEBUG='*'. Document that debug mode exposes additional error information, especially transaction hashes; it is done when users can find and understand this guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100