Skip to content

docs: improve grammar in CONTRIBUTING.rst - #2281

Merged
waketzheng merged 2 commits into
tortoise:developfrom
TianHengZhuang:docs/fix-contributing-grammar
Sep 15, 2026
Merged

waketzheng merged 2 commits into
tortoise:developfrom
TianHengZhuang:docs/fix-contributing-grammar

Conversation

@TianHengZhuang

Copy link
Copy Markdown
Contributor

Summary

Polishes two awkward sentences in docs/CONTRIBUTING.rst (target branch: develop):

  1. Opening sentence: clearer punctuation and article usage.
  2. Coding guideline intro: "We believe to keep" → "We believe in keeping"; "less place" → "fewer places".

Testing

Documentation-only change (reStructuredText).

- clarify opening contribute sentence
- We believe to keep -> We believe in keeping; less place -> fewer places
@codspeed

codspeed Bot commented Sep 14, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 24 untouched benchmarks


Comparing TianHengZhuang:docs/fix-contributing-grammar (e280273) with develop (95795cc)

Open in CodSpeed

waketzheng
waketzheng previously approved these changes Sep 14, 2026
@waketzheng

Copy link
Copy Markdown
Contributor
  • Docs and pre-commit config only; no source code changes.
  • The .pre-commit-config.yaml change only adds manual-stage hooks
    (mypy, bandit, build, twine) to support the documented
    uvx prek run --all-files --group check command. It does not affect
    existing hooks or default behavior.

@waketzheng
waketzheng merged commit aec6108 into tortoise:develop Sep 15, 2026
25 checks passed
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.

2 participants