PowerShell / PowerShell/PSScriptAnalyzer

Properly document PSSA2

Ouverte
#1,487 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Consider - 2.0
Langage dominant
C#
Étoiles
2.2k
Forks
414
Merge moyen
13 h 1 min
PR mergées (30 j)
2

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par inventorier les règles, la configuration et le comportement de suppression du projet, le modèle d’hébergement, l’architecture et le README existant. Examinez les chemins d’implémentation des règles .NET et PowerShell afin d’identifier les commentaires et les exemples d’API qui doivent être documentés. La tâche est terminée lorsque la documentation du README, de la configuration pour les utilisateurs et les contributeurs, de la référence des règles, de la configuration, de la suppression, de l’hébergement, de l’architecture et de la création de règles est complète.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp, powershell
Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.