Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Ruff to Suggested Formatters and Linters #1

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Ruff to Suggested Formatters and Linters #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ Below is an **enhanced** version of the **General Guidance** section. The origin
> [!TIP]
> **Best Practices**:
>
> - Use a **linter** (e.g., **Flake8**, **Pylint**) to detect issues (undefined variables, unused imports).
> - Use a **formatter** (e.g., **Black**, **Autopep8**) to standardize indentation, spacing, and line lengths.
> - Use a **linter** (e.g., **ruff**, **Flake8**, **Pylint**) to detect issues (undefined variables, unused imports).
> - Use a **formatter** (e.g.,**ruff**, **Black**, **Autopep8**) to standardize indentation, spacing, and line lengths.
> - **Always** run linting/formatting—either locally before committing or via pre-commit hooks—to ensure code consistency across the team.

---
Expand Down Expand Up @@ -158,7 +158,7 @@ Below is an **enhanced** version of the **General Guidance** section. The origin
> [!TIP]
> **Best Practices**:
>
> - Document your lint and format processes (e.g., “Run `black . && flake8 .` before committing”).
> - Document your lint and format processes (e.g., “Run `black . && flake8 .` or `ruff format` before committing”).
> - Integrate them into your dev container configuration, pre-commit hooks, and CI.
> - Use a standard config file (like `pyproject.toml` for Black) so the entire team (and CI) uses the same style rules.

Expand Down