PowerShell / PowerShell/PSScriptAnalyzer
Properly document PSSA2
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia facendo un inventario delle regole del progetto, della configurazione e del comportamento di soppressione, del modello di hosting, dell’architettura e del README esistente. Esamina i percorsi di implementazione delle regole .NET e PowerShell per identificare i commenti e gli esempi dell’API che richiedono documentazione. Il lavoro è completo quando sono complete la documentazione del README, della configurazione per utenti e collaboratori, del riferimento delle regole, della configurazione, della soppressione, dell’hosting, dell’architettura e della creazione delle regole.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, powershell
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 20/100