kthcloud / kthcloud/go-deploy

Unclear readme for local dev

Open Beginner friendly
#674 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Go
Stars
3
Forks
1
PR merge metrics
No merged PRs in 30d

Description

In the local dev readme (https://github.com/kthcloud/go-deploy/blob/dev/scripts/local/README.md), the instructions refer to packages that *will* be installed, however when using the script it becomes apparent these are prerequisites and not side effects of the script. Perhaps stating they need to be installed by the user beforehand would be beneficial.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open scripts/local/README.md and review the instructions for the packages used by the local development script. Update the wording so it clearly states that these packages are prerequisites the user must install beforehand, rather than dependencies installed by the script. Done means the README accurately describes the script's behavior.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.