jeffhacks/smbscan

Improve Help Screen and documentation

Offen

#25 geöffnet am 13.05.2022

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (6 Forks)github user discovery
documentationgood first issue

Repository-Metriken

Stars
 (49 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

  • include which default options / parameters are being used in the help screen (eg if you were to run python3 smbscan.py ip)
  • suggested scans
  • list and detail options / flags in readme documentation

Contributor Guide

Research-Richtung
Überprüfe die aktuelle Hilfebildschirmausgabe und die README, füge dann Standardwerte für Optionen und vorgeschlagene Scanbeispiele sowohl in der Hilfe als auch in der Dokumentation hinzu.
Tech Stack
python
Domain
clisecurity
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90