lintsinghua / lintsinghua/DeepAudit
Should we run ruff format on the codebase?
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7k
- Forks
- 850
- PR merge metrics
- No merged PRs in 30d
Description
我注意到项目已经在 pyproject.toml 中配置了 Ruff，但代码库中似乎还有不少 format 不规范的代码。For example in backend/app/api/v1/endpoints/config.py :
from typing import Any, Optional
from fastapi import APIRouter, Depends, HTTPException
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.future import select
from pydantic import BaseModel
import json
Import 的顺序是不太合理的
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the Ruff configuration in pyproject.toml and reviewing the example file, backend/app/api/v1/endpoints/config.py. Run the configured Ruff formatting check to measure the scope, then determine whether the requested outcome is formatting the whole codebase and confirm completion by rerunning the check.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100