PowerShell / PowerShell/PSScriptAnalyzer
Show documentation on custom rules
オープン
まだ誰も着手していません。
Up-for-Grabs
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR（30日）
- 2
説明
I have noticed the new support for Show documentation for pops up as a suggested correction. However, when using custom rules this uses this github repo and results in a 404 (e.g. https://github.com/PowerShell/PSScriptAnalyzer/blob/development/RuleDocumentation/Measure-PascalCase.md). Is it possible to use a custom url for this feature? This would allow us to direct the documentation at our own internal spaces.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
Issue に記載されている既存の「Show documentation for 」の動作と、カスタムルールが現在どのように RuleDocumentation のサンプル URL を解決しているかを、まず追跡します。カスタムルールが設定されたドキュメント URL を使用でき、リポジトリーベースの 404 を生成しなくなれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, powershell
- 領域
- tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 25/100