PowerShell / PowerShell/PSScriptAnalyzer
Properly document PSSA2
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C#
- Sterne
- 2.2k
- Forks
- 414
- Ø Merge
- 13 Std. 1 Min.
- Gemergte PRs (30 T.)
- 2
Beschreibung
PSSA2 should have full documentation. This includes:
- Descriptive code comments that can be used to provide API documentation for consumers
- Documentation of all rules
- Documentation of configuration and how to configure and run for users
- Documentation on rule suppression
- Documentation on hosting
- Documentation on implementing a rule in both .NET and PS script
- Documentation on the project's architecture
- A full README on how to build, run and contribute
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die Regeln, die Konfiguration und das Suppressionsverhalten, das Hosting-Modell, die Architektur und die vorhandene README des Projekts zu inventarisieren. Überprüfe die Implementierungspfade für .NET- und PowerShell-Regeln, um die API-Kommentare und Beispiele zu identifizieren, die dokumentiert werden müssen. Erledigt ist die Aufgabe, wenn die Dokumentation zu README, der Einrichtung für Benutzer und Mitwirkende, der Regelreferenz, der Konfiguration, der Suppression, dem Hosting, der Architektur und der Regelerstellung vollständig ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp, powershell
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 20/100