PowerShell / PowerShell/PSScriptAnalyzer
Properly document PSSA2
オープン
まだ誰も着手していません。
Consider - 2.0
- 主要言語
- C#
- スター
- 2.2k
- フォーク
- 414
- 平均マージ
- 13時間 1分
- マージ済み PR(30日)
- 2
説明
PSSA2 should have full documentation. This includes:
- Descriptive code comments that can be used to provide API documentation for consumers
- Documentation of all rules
- Documentation of configuration and how to configure and run for users
- Documentation on rule suppression
- Documentation on hosting
- Documentation on implementing a rule in both .NET and PS script
- Documentation on the project's architecture
- A full README on how to build, run and contribute
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、プロジェクトのルール、設定、抑制の動作、ホスティングモデル、アーキテクチャ、既存のREADMEを洗い出します。.NETおよびPowerShellのルール実装パスを確認し、ドキュメント化が必要なAPIコメントと例を特定します。README、ユーザーとコントリビューター向けのセットアップ、ルールリファレンス、設定、抑制、ホスティング、アーキテクチャ、ルール作成のドキュメントが完成すれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp, powershell
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 20/100