Skip to content

spelling improvement in README #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
chicks-net wants to merge 2 commits into
base: main
Choose a base branch
from
Open

spelling improvement in README #1

chicks-net wants to merge 2 commits into from

Conversation

@chicks-net
Copy link

@chicks-net chicks-net commented Nov 1, 2025 •
edited
Loading

Context

Stating that

Only web ports could be exposed

implies that that is all that is possible. I think you meant should instead of could.

Changes

  • Replace "could" with "should" which seems more befitting of interview challenge instructions
  • Dashes for Markdown lists is best practice and makes the README.md internally consistent.

Verify

% markdownlint-cli2 README.md
markdownlint-cli2 v0.18.1 (markdownlint v0.38.0)
Finding: README.md
Linting: 1 file(s)
Summary: 0 error(s)
% md5sum README.md
27c8acdab326f4a2168bd94b1602f2b2  README.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@chicks-net