PowerShell / PowerShell/PSScriptAnalyzer
Improve rule suppression documentation
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 414
- Merge medio
- 13 h 1 min
- PR fusionados (30 d)
- 2
Descripción
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
)
}
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.
Línea de trabajo
El issue no menciona ningún archivo de documentación ni ninguna prueba. Comienza localizando la documentación existente sobre la supresión de reglas y revisando cómo gestiona PSSA el ejemplo mostrado de SuppressMessageAttribute, incluidos los valores de rulesuppressionid. Se considera terminado cuando la documentación explica el comportamiento de la supresión por regla y cubre el ejemplo PSavoidUsingUserNameAndPassWordParams.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- powershell
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100