crytic/slither

slither-doc: generate doc from natspec

Open

#857 opened on 2021年5月28日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (平均マージ 54d 9h) (30d で 2 merged PRs)

説明

From @Arachnid recent tweet, it looks like there is not good up to date solution to generate doc from natspec. We should explore the current solutions and create something on top of slither

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

調査方針
既存のSolidity natspecドキュメント生成ツールを調査し、slitherと統合するソリューションを設計してください。
技術スタック
python
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonGitSolidity
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50