wormhole-foundation/wormhole

Improve EVM contract natspec docs

开放

#3,477 创建于 2023年10月30日

在 GitHub 查看贡献者指南
 (4 条评论) (0 个反应) (0 位负责人)TypeScript (854 个派生)auto 404
good first issue

仓库指标

星标
 (1,895 个星标)
PR 合并指标
 (平均合并 17天 14小时) (30 天内合并 15 个 PR)

描述

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
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Solidity
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80