PowerShell / PowerShell/PSScriptAnalyzer
Properly document PSSA2
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 2.2k
- Forks
- 414
- Merge medio
- 13 h 1 min
- PR fusionados (30 d)
- 2
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza inventariando las reglas, la configuración y el comportamiento de supresión del proyecto, el modelo de hosting, la arquitectura y el README existente. Revisa las rutas de implementación de reglas de .NET y PowerShell para identificar los comentarios y ejemplos de la API que necesitan documentación. La tarea estará completa cuando estén terminadas la documentación del README, de la configuración para usuarios y colaboradores, de la referencia de reglas, de la configuración, de la supresión, del hosting, de la arquitectura y de la autoría de reglas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- csharp, powershell
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100