Skip to content

docs: improve Code Style section in CONTRIBUTING.md#4422

Open
yuchengpersonal wants to merge 1 commit intorysweet:mainfrom
yuchengpersonal:docs/fix-code-style-section
Open

docs: improve Code Style section in CONTRIBUTING.md#4422
yuchengpersonal wants to merge 1 commit intorysweet:mainfrom
yuchengpersonal:docs/fix-code-style-section

Conversation

@yuchengpersonal
Copy link
Copy Markdown

Summary

This PR improves the Code Style section in CONTRIBUTING.md to make it more actionable for new contributors:

  1. Specifies that Python code uses for linting and formatting, and provides the command to auto-fix pre-commit failures
  2. Adds a relative link to for Markdown style rules
  3. Adds a note explaining what pre-commit checks run automatically
  4. Fixes the typo of 'well-documented' (was missing the trailing 'd')

Fixes #4421

@github-actions github-actions Bot added documentation Improvements or additions to documentation triage:low-risk triage:needs-review labels Apr 20, 2026
This was referenced Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: CONTRIBUTING.md "Code Style" section gives no actionable guidance for new contributors

1 participant