What and why
Our documentation style avoids em dashes and en dashes in favor of commas, colons, parentheses, or separate sentences. Several markdown files on main still contain them. This is a pure wording cleanup, ideal as a first documentation contribution.
Pointers
Files currently containing em dashes:
CONTRIBUTING.mdREADME.mdSECURITY.mdTHIRD_PARTY_NOTICES.mdopen_kgo/feature_groups/kg/README.md
Steps
- Search these files for
— and –.
- Rewrite each sentence with a comma, colon, parentheses, or a period, keeping the meaning intact. Do not change code blocks or license texts quoted verbatim.
- Run
tox to confirm nothing else broke.
Acceptance criteria
- No em or en dashes remain in the listed files (outside verbatim license quotations, if any).
- Sentences still read naturally; no content meaning changed.
Notes
This project uses semantic versioning driven by Conventional Commits, so the PR title matters: use docs: replace em dashes with plain punctuation.
New to the project? This issue is a good entry point, we are happy to help in the comments.
If you like the project, a star on the repo helps others find it. ⭐
What and why
Our documentation style avoids em dashes and en dashes in favor of commas, colons, parentheses, or separate sentences. Several markdown files on main still contain them. This is a pure wording cleanup, ideal as a first documentation contribution.
Pointers
Files currently containing em dashes:
CONTRIBUTING.mdREADME.mdSECURITY.mdTHIRD_PARTY_NOTICES.mdopen_kgo/feature_groups/kg/README.mdSteps
—and–.toxto confirm nothing else broke.Acceptance criteria
Notes
This project uses semantic versioning driven by Conventional Commits, so the PR title matters: use
docs: replace em dashes with plain punctuation.New to the project? This issue is a good entry point, we are happy to help in the comments.
If you like the project, a star on the repo helps others find it. ⭐