Refactor PowerShell adapter module code for maintainability
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 42/100
- Tipo de issue
- Refactorización
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- powershell
- Área
- tooling
Línea de trabajo
Comienza localizando el script de entrada compartido y los módulos psDscAdapter y win_psDscAdapter; después, relaciona sus implementaciones duplicadas y las pruebas de aceptación existentes. Define las funciones compartidas, sus parámetros y los datos que devuelven, así como el alcance de las pruebas unitarias de las funciones privadas, antes de reestructurar; el trabajo estará terminado cuando ambos adaptadores utilicen el módulo común y las nuevas pruebas unitarias cubran el comportamiento extraído.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Rust
- Estrellas
- 532
- Forks
- 76
- Merge medio
- 2 d 28 min
- PR fusionados (30 d)
- 17
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de PowerShell/DSC
-
Issue-Enhancement Needs Triage
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
PowerShell/DSC#1737 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
PowerShell/DSC#1736 ·
Los mantenedores suelen responder en 1 día
-
`directives.version` is checked against dsc-lib's crate version (3.2.0), not the running dsc versionPosiblemente ocupada @michaeltlombardi la tomó hace 2 días. AbiertoIssue-Bug
Dificultad 3/5 Medio día Aptitud para principiantes 74/100
PowerShell/DSC#1735 · 1 comentario · 1 reacción · 1 asignado ·
Los mantenedores suelen responder en 1 día
-
Make it impossible to accidentally define a nonfunctional secret extensionPosiblemente ocupada @Gijsreyn la tomó hoy. AbiertoIssue-Enhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 38/100
PowerShell/DSC#1729 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Feature Request: Support dsc functions in executable argsPosiblemente ocupada @SteveL-MSFT la tomó hace 13 días. AbiertoIssue-Enhancement
Dificultad 4/5 3-5 días Aptitud para principiantes 62/100
PowerShell/DSC#1722 · 4 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de PowerShell/DSC
Issues similares
-
documentation enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
adorsys/status-list-server#619 ·
Los mantenedores suelen responder en 2 días
-
batch-backport only backports the first 30 matching PRsPosiblemente ocupada @DvirDukhan la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 5 días
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
equinor/septic-config-generator#481 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día