vinitshahdeo/PortScanner

[Documentation]Update working of the project in docs

Open

#62 opened on Aug 16, 2020

View on GitHubContributor guide
 (9 comments) (0 reactions) (1 assignee)Python (122 forks)auto 404
CH20Level1beginner friendlydocumentationeasygood first issuegssoc21hacktoberfesthelp wantedup for grabs

Repository metrics

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

Description

Analyze the working of the project and update the documentation in docs/Documentation.docx and docs/documentation.md.

Create a PR in feature/documentation branch.

PS: Checkout README.md for further details.

Contributor guide

Research direction
Analyze the project's working by reading the README and existing documentation, then update docs/Documentation.docx and docs/documentation.md to reflect the correct functionality.
Tech stack
python
Domain
backend
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85