Add information on documenting directives
オープン
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 142
- フォーク
- 230
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
We don't currently have any guidelines around documenting elements or directives. Might be something like this:
Documenting directives
To add API documentation to directives, we recommend adding a doc comment on the directive function:
/**
* Renders a placeholder message until `promise` resolves, then renders the
* value of the fulfilled promise.
* @param promise A promise that yields a value to render
*/
export const resolvePromise = directive(ResolvePromise);
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
directive API のガイダンスに適したドキュメントセクションを lit.dev リポジトリ内で見つけてください。提案されている「Documenting directives」の内容と例を出発点として使用してください。公開されたガイダンスで directives の doc comment とパラメータのドキュメント化が説明されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 48/100