vinitshahdeo/PortScanner

Documentation error

Open

#69 opened on Aug 17, 2020

View on GitHubContributor guide
 (3 comments) (0 reactions) (1 assignee)Python (122 forks)auto 404
documentationeasygood first issuehacktoberfesthelp wantedup for grabs

Repository metrics

Stars
 (150 stars)
PR merge metrics
 (PR metrics pending)

Description

There is a minute error in documentation. Step 5 in How to run(UI) section says the following command python mainScanner.py where it should be python src/mainScanner.py

Contributor guide

Research direction
Update the command in the documentation from `python mainScanner.py` to `python src/mainScanner.py` in step 5 of the 'How to run (UI)' section.
Tech stack
python
Domain
documentation
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90