PowerShell / PowerShell/PSScriptAnalyzer

Add suggestion to read About_TOPIC files to Script Analyzer rules

Ouverte
#575 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Area - Documentation Area - Rules Issue - Enhancement
Langage dominant
C#
Étoiles
2.2k
Forks
414
Merge moyen
13 h 1 min
PR mergées (30 j)
2

Description

When you have a Rule run for example the PSUseOutputTypeCorrectly I would suggest adding in information to the rule Output to the user to check any possible corresponding About_help Topic for information on how to mitigate the rule being flagged.

@juneb - What do you think to this idea?

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner la sortie de la règle PSUseOutputTypeCorrectly et les indications d’aide About_TOPIC correspondantes. Déterminez comment les messages de règle applicables pourraient orienter les utilisateurs vers des informations sur les mesures d’atténuation, et examinez les autres règles de Script Analyzer qui pourraient avoir des topics correspondants. Le travail est terminé lorsque la sortie des règles concernées renvoie systématiquement les utilisateurs vers les indications appropriées.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
powershell
Domaine
devtools
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.