wormhole-foundation/wormhole

Improve EVM contract natspec docs

オープン

#3,477 opened on 2023/10/30

GitHub で見るコントリビューターガイド
 (4 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (854 件のフォーク)auto 404
good first issue

Repository metrics

Stars
 (1,895 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド

調査方針
リポジトリ内のコアEVMコントラクトを特定し、既存のドキュメントスタイルに従ってパブリック関数にnatspecコメントを追加します。
技術スタック
なし
領域
documentationblockchain
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Solidity
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80