violentmonkey / violentmonkey/violentmonkey.github.io
[Feature] Add docs for @updateURL
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- MDX
- スター
- 55
- フォーク
- 35
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
Motivation
Developers need proper docs in order to use all features supported by violentmonkey.
Seems like there is no info in the https://violentmonkey.github.io/api/metadata-block/ about @updateURL
Proposed Solution
- Explain if
@updateURLis supported or not. An can be used for *.meta.js files only. - Give example of usage at public docs.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue にリンクされている公開 API のメタデータブロックのドキュメントページから始め、そのソースをリポジトリ内で確認します。@updateURL がサポートされているか、また *.meta.js ファイルにのみ適用されるかを確認し、使用例とともに結果を文書化します。ページで動作が説明され、有効な使用方法が示されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 45/100