Skip to content

added the formatter documentation#60

Merged
grzanka merged 6 commits intomainfrom
change-the-formatter-to-ruff
Mar 31, 2026
Merged

added the formatter documentation#60
grzanka merged 6 commits intomainfrom
change-the-formatter-to-ruff

Conversation

@dazakdev
Copy link
Copy Markdown
Contributor

This pull request updates documentation across several files to reflect the migration from YAPF and isort to Ruff for Python linting and formatting. The changes clarify that Ruff is now the standard tool for both linting and formatting in the backend, and provide updated configuration examples and guidance for contributors.

Migration to Ruff for Python code quality:

  • Replaced references to YAPF and isort with Ruff in documentation, specifying that Ruff handles both linting and formatting tasks. [1] [2] [3] [4]
  • Added detailed configuration examples for using Ruff with pre-commit, including example .pre-commit-config.yaml and notes on additional checks.

Contributor guidance updates:

  • Provided instructions for handling git blame after large automated refactors, suggesting the use of .git-blame-ignore-revs to minimize noise from formatting commits.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates developer documentation to reflect the migration from YAPF/isort to Ruff as the standard Python linter/formatter across backend/converter workflows, including pre-commit guidance.

Changes:

  • Replaced YAPF/isort mentions with Ruff linting + formatting in testing/setup docs.
  • Expanded contributing code-style docs with a Ruff-centric pre-commit example and git blame guidance after reformatting.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File Description
src/content/docs/local-setup/local-celery.mdx Updates local setup docs to reference Ruff-based formatting via pre-commit.
src/content/docs/converter/testing.md Updates converter testing docs to list Ruff hooks instead of YAPF/isort.
src/content/docs/contributing/code-style.md Adds Ruff tooling section, a pre-commit example snippet, and blame.ignoreRevsFile guidance.
src/content/docs/backend/testing.md Updates backend testing docs to list Ruff hooks instead of YAPF/pycodestyle.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
dazakdev and others added 2 commits March 31, 2026 14:05
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@grzanka grzanka merged commit 69af09d into main Mar 31, 2026
8 checks passed
@grzanka grzanka deleted the change-the-formatter-to-ruff branch March 31, 2026 12:17
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.

3 participants