wormhole-foundation/wormhole

Improve EVM contract natspec docs

Aperta

#3477 aperta il 30 ott 2023

Vedi su GitHubGuida contributor
 (4 commenti) (0 reazioni) (0 assegnatari)TypeScript (854 fork)auto 404
good first issue

Metriche repository

Star
 (1895 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica i contratti EVM principali nel repository e aggiungi commenti natspec alle funzioni pubbliche seguendo lo stile di documentazione esistente.
Tech stack
Nessuno
Dominio
documentationblockchain
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Solidity
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80