jeffhacks/smbscan

Improve Help Screen and documentation

Open

#25 opened on May 13, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (5 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (49 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

  • 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 direction
Examine the current help screen output and README, then add default values for options and suggested scan examples in both help and documentation.
Tech stack
python
Domain
clisecurity
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90