Skip to content

docs: fix typos in CONTRIBUTING.md#1796

Open
immanuwell wants to merge 1 commit into
containers:mainfrom
immanuwell:docs/contributing-typos
Open

docs: fix typos in CONTRIBUTING.md#1796
immanuwell wants to merge 1 commit into
containers:mainfrom
immanuwell:docs/contributing-typos

Conversation

@immanuwell
Copy link
Copy Markdown

@immanuwell immanuwell commented May 25, 2026

A few lines in CONTRIBUTING.md have obvious wording slips, so the contributor guide reads kinda rough in a couple spots. Tiny paper cut

Open CONTRIBUTING.md, read the lines with some of it's functionality, as it's buildsystem, has it's documentation, take the us some time, and mail fail. The typos show up right away

This PR just cleans up those phrases

Signed-off-by: immanuwell <pchpr.00@list.ru>
@immanuwell immanuwell requested a review from debarshiray as a code owner May 25, 2026 14:30
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request corrects several typos and grammatical errors in the CONTRIBUTING.md file, including fixing possessive pronouns, word spacing, and spelling mistakes. A review comment suggests further refining the text by removing the hyphen from 'false-positive' when used as a noun, which aligns with the PR's objective of improving documentation clarity.

Comment thread CONTRIBUTING.md
Toolbx has a CI (Continuous Integration) setup for running tests. Their goal is to check if your
changes don't affect adversely Toolbx's functionality. Sometimes these tests
mail fail with a false-positive. If you are not sure about the outcome of the
may fail with a false-positive. If you are not sure about the outcome of the
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The term "false positive" is typically used as two separate words when functioning as a noun. Hyphenation is generally reserved for its use as a compound adjective (e.g., "a false-positive result"). Since this pull request specifically targets typos and wording improvements, it would be better to use the standard noun form here.

Suggested change
may fail with a false-positive. If you are not sure about the outcome of the
may fail with a false positive. If you are not sure about the outcome of the

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant