PowerShell / PowerShell/PSScriptAnalyzer
Improve rule suppression documentation
オープン
まだ誰も着手していません。
Area - Documentation
Issue - Enhancement
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
Existing documentation doesn't provide any information regarding rule-wise behavior of code suppression.
For example, PSSA cannot suppress PSAvoidUsingUserNameAndPassWordParams violations based on given rulesuppressionid.
Configuration Foo
{
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "UserName", Scope="Function")]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordPara", "EncryptedPassword", Scope="Function")]
param (
[Parameter(Mandatory)]
[String]$UserName,
[Parameter(Mandatory)]
[String]$Password
)
}
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
この issue では、ドキュメントファイルもテストも指定されていません。まず既存のルール抑制に関するドキュメントを見つけ、示されている SuppressMessageAttribute の例を PSSA がどのように処理するかを、rulesuppressionid の値を含めて確認してください。完了条件は、ドキュメントでルールごとの抑制動作を説明し、PSavoidUsingUserNameAndPassWordParams の例を扱っていることです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- powershell
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100