Auto-generate the file-level documentation from its contents
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- cpp, jekyll
- 領域
- documentation, tooling
調査の方向性
まず、brief フィールドと owner フィールドが現在クラスのドキュメントでどのように表現され、各ファイルの index.md にコピーされているかを追跡します。単一クラスの場合と複数のサブエンティティを含むファイルを比較し、そのうえで継承フィールドやオプションフィールドがどのように振る舞うべきか、また変更を確認できるドキュメント出力が何であるべきかを定義します。
索引モデルが issue の本文から書いたものです。
説明
The brief and owner fields in index.md for a class and the file that contains it should be inherited (somehow) from the class documentation itself. When there's a single class in a file, it seems silly to copy the brief and owner up to the index file(s).
Another option would be to make those fields __OPTIONAL__ if there's a single sub-entity in the file. No need to copy if it's just going to be redundant.
- 主要言語
- C++
- スター
- 341
- フォーク
- 45
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
adobe/hyde のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 15/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 3 日以内に返信
-
backlog
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
EchoTools/nevr-runtime#2385 ·
メンテナーはふだん 1 日以内に返信
-
type:bug
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
tensorflow/tflite-micro#3995 ·
メンテナーはふだん 1 日以内に返信
-
CPU update 1.31xオープンspeed-report
難易度 1/5 1時間未満 初心者へのやさしさ 75/100
mw00/project-maya#961 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100