wormhole-foundation/wormhole

Improve EVM contract natspec docs

Open

#3,477 opened on Oct 30, 2023

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)TypeScript (854 forks)auto 404
good first issue

Repository metrics

Stars
 (1,895 stars)
PR merge metrics
 (PR metrics pending)

Description

Description and context

Go through core EVM contracts and improve natspec documentation for public functions.

Definition of done

Docs are in a state where forge doc can auto-generate documents we'd be comfortable putting on docs.wormhole.com.

Contributor guide

Research direction
Identify core EVM contracts in the repository and add natspec comments to public functions following the existing documentation style.
Tech stack
None
Domain
documentationblockchain
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Solidity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80