aRustyDev / aRustyDev/dotfiles

Docs: Module Documentation Standards

オープン
#46 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
Jupyter Notebook
スター
1
フォーク
0
PR マージ指標
30日以内にマージされた PR はありません

説明

Define documentation requirements

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

この issue ではファイル、テスト、エントリーポイントが指定されていないため、まず対象となるモジュールとドキュメントの場所を明確にしてください。完了とは、合意したモジュールドキュメントの要件一式が文書化されている状態を指しますが、この issue ではその要件も検証手順も定義されていません。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。