PowerShell / PowerShell/PSScriptAnalyzer

New function: Show-RuleHelp

Offen
#730 8 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

I have a function to submit, Show-RuleHelp, which opens the .md file of help for each rule. Before I do a PR, I want to know if you're interested in including it and, if so, how?

-- Add the script containing the function to ScriptsToProcess
-- Add the function to PSScriptAnalyzer.psm1 + FunctionsToExport in the psd1

You can see the code at https://github.com/juneb/Development/blob/master/Show-RuleHelp.ps1.

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

Beginne mit der Überprüfung der verlinkten Show-RuleHelp.ps1-Implementierung und untersuche anschließend PSScriptAnalyzer.psm1 sowie die im Issue genannten Einträge des Modulmanifests. Ermittle, ob die Funktion zu ScriptsToProcess gehört und exportiert werden sollte; abgeschlossen ist die Aufgabe, wenn ein Einschlusspfad festgelegt und das Verhalten des resultierenden Moduls validiert wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
powershell
Bereich
cli, documentation
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 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.