Refactor PowerShell adapter module code for maintainability
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 42/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- powershell
- 領域
- tooling
調査の方向性
まず共有エントリポイントスクリプトと psDscAdapter モジュールおよび win_psDscAdapter モジュールを見つけ、それらの重複した実装と既存の受け入れテストを対応付けます。再構成する前に、共有関数、そのパラメーターと戻りデータ、およびプライベート関数のユニットテストの範囲を定義します。完了条件は、両方のアダプターが共通モジュールを使用し、新しいユニットテストが抽出した動作をカバーすることです。
索引モデルが issue の本文から書いたものです。
説明
Summary of the new feature / enhancement
As a maintainer of DSC, I want to be able to readily navigate, understand, and update the PowerShell adapter code so that I can effectively contribute and troubleshoot the adapters.
Currently, the PowerShell adapter implementations share an entrypoint script but define two separate modules with shared implementations for functionality duplicated in both modules.
Additionally, the code organization is a bit difficult to follow and uses long complex statements repeatedly through the code which could potentially be encapsulated into small functions for easier testing and debugging.
Proposed technical implementation details (optional)
I propose that we:
- Extract common functions into a
common_psDscAdaptermodule that bothpsDscAdapterandwin_psDscAdaptercan depend on. - Standardize and at least minimally document the functions - their parameters, usage, and return data - for easier cognitive loading for maintainers. Even though this code won't be seen or used directly by end users, this reference information can help maintainers and new contributors.
- Examine the implementation for code that can be extracted into useful functions for the purposes of testing and making the overall implementation easier to read and follow.
- Add unit testing for the private functions to verify behavior and make maintenance easier and safer. We currently rely almost exclusively on acceptance tests that invoke the adapter code through DSC, which is necessarily slower and involves more levels of indirection.
- 主要言語
- Rust
- スター
- 536
- フォーク
- 76
- 平均マージ
- 1日 11時間
- マージ済み PR（30日）
- 15
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
PowerShell/DSC のほかの issue
-
Issue-Enhancement Needs Triage
難易度 4/5 3〜5日 初心者へのやさしさ 30/100
PowerShell/DSC#1750 · コメント 3 件 ·
メンテナーはふだん 1 日以内に返信
-
Issue-Bug Need-Review
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
PowerShell/DSC#1749 ·
メンテナーはふだん 1 日以内に返信
-
Issue-Bug Need-Review
難易度 3/5 1〜2日 初心者へのやさしさ 40/100
PowerShell/DSC#1748 · コメント 5 件 ·
メンテナーはふだん 1 日以内に返信
-
"apt install dsc" will install the preview release instead of stable対応中かも @SteveL-MSFT が 4 日前に担当しました。 オープンIssue-Bug Need-Review
PowerShell/DSC#1746 · コメント 1 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Issue-Enhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
PowerShell/DSC#1737 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
extendr/extendr.github.io#134 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
bgreenwell/xleak#90 · リアクション 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
cloudflare/boring#530 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
project-robius/robrix#1154 ·
メンテナーはふだん 1 日以内に返信