Skip to content

docs: update contributing checks#2215

Open
waketzheng wants to merge 1 commit into
tortoise:developfrom
waketzheng:update-contributing
Open

docs: update contributing checks#2215
waketzheng wants to merge 1 commit into
tortoise:developfrom
waketzheng:update-contributing

Conversation

@waketzheng
Copy link
Copy Markdown
Contributor

@waketzheng waketzheng commented Jun 7, 2026

Description

Update the contribution guide to mention pre-commit run --all-files as an alternative way to run automated style and lint checks alongside make check.

Motivation and Context

The repository already provides a .pre-commit-config.yaml and documents pre-commit install in the development setup flow.
Mentioning pre-commit run --all-files gives contributors a clearer way to manually run the configured hooks across the project.

How Has This Been Tested?

Ran:

  • git diff --check
  • pre-commit run --files docs/CONTRIBUTING.rst

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added the changelog accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Jun 7, 2026

Merging this PR will not alter performance

✅ 24 untouched benchmarks


Comparing waketzheng:update-contributing (00c621d) with develop (c8ed5e9)

Open in CodSpeed

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