PowerShell / PowerShell/PSScriptAnalyzer

Add suggestion to read About_TOPIC files to Script Analyzer rules

Offen
#575 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Area - Documentation Area - Rules Issue - Enhancement
Vorherrschende Sprache
C#
Sterne
2.2k
Forks
414
Ø Merge
13 Std. 1 Min.
Gemergte PRs (30 T.)
2

Beschreibung

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?

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der Überprüfung der Ausgabe der Regel PSUseOutputTypeCorrectly und der entsprechenden About_TOPIC-Hilfeanleitung. Ermitteln Sie, wie anwendbare Regelmeldungen Benutzer zu Informationen über Abhilfemaßnahmen weiterleiten könnten, und berücksichtigen Sie die anderen Script Analyzer-Regeln, für die möglicherweise entsprechende topics existieren. Als abgeschlossen gilt die Aufgabe, wenn die Ausgabe der relevanten Regeln konsistent auf die passende Anleitung verweist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
powershell
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.