Merged
Conversation
github-actions
bot
added
area/docs
Review Summary by QodoSync CONTRIBUTING and README with updated requirements and URLs
WalkthroughsDescription• Updated Python version requirement from 3.8+ to 3.10+ across docs • Corrected repository URL from WhaleWhisper to whale-whisper • Updated frontend port from 5173 to 5174 and added uv run prefix • Clarified frontend code organization and removed typecheck command • Added security vulnerability reporting guidelines • Updated dependencies: Node.js 16+ to 20+, pnpm 8+ to 9.12.2 • Reorganized project structure documentation with apps/ subdirectory Diagramflowchart LR
A["Documentation Files"] -->|Update Python version| B["3.8+ → 3.10+"]
A -->|Correct URLs| C["WhaleWhisper → whale-whisper"]
A -->|Update ports| D["5173 → 5174"]
A -->|Update dependencies| E["Node.js 16+ → 20+<br/>pnpm 8+ → 9.12.2"]
A -->|Add guidelines| F["Security reporting<br/>Code organization"]
File Changes1. CONTRIBUTING.md
|
Contributor
Greptile OverviewGreptile SummaryThis PR synchronizes the documentation (CONTRIBUTING.md and README.md) with the actual project configuration and current repository state. Key Updates:
All changes are documentation-only updates that improve accuracy and align with the codebase reality. No functional code changes. Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| CONTRIBUTING.md | Synchronized documentation with actual project configuration: updated Python version requirement (3.8+ → 3.10+), fixed repository URLs, corrected dev server port (5173 → 5174), updated backend commands to use uv run, improved frontend code organization guidance, and added security reporting section |
| README.md | Aligned README with current project state: updated version requirements (Python 3.10+, Node.js 20+, pnpm 9.12.2), corrected frontend port (5173 → 5174), fixed repository URLs, updated project structure to reflect actual organization, and corrected contributors badge URL |
Sequence Diagram
sequenceDiagram
participant Dev as Developer
participant Repo as Repository
participant CI as CI Environment
participant Docs as Documentation
Note over Dev,Docs: Documentation Sync Process
Dev->>Repo: Check actual configuration
activate Repo
Repo-->>Dev: pyproject.toml (Python 3.10+)
Repo-->>Dev: vite.config.ts (port 5174)
Repo-->>Dev: package.json (pnpm 9.12.2)
Repo-->>Dev: Repository URL (whale-whisper)
deactivate Repo
Dev->>Docs: Update CONTRIBUTING.md
activate Docs
Note right of Docs: - Python 3.8+ → 3.10+<br/>- Port 5173 → 5174<br/>- Add CI environment specs<br/>- Fix repository URLs<br/>- Update commands (uv run)<br/>- Add security section
deactivate Docs
Dev->>Docs: Update README.md
activate Docs
Note right of Docs: - Python 3.8+ → 3.10+<br/>- Node.js 16+ → 20+<br/>- pnpm 8+ → 9.12.2<br/>- Port 5173 → 5174<br/>- Fix URLs and badges<br/>- Update project structure
deactivate Docs
Dev->>CI: Submit PR to dev branch
CI->>Docs: Validate documentation consistency
CI-->>Dev: Documentation now matches actual config
Code Review by Qodo
1. uv/venv launch mismatch
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
| ```bash | ||
| # 后端（在 backend/ 目录） | ||
| uvicorn app.main:app --reload --port 8090 | ||
| uv run uvicorn app.main:app --reload --port 8090 |
There was a problem hiding this comment.
1. Uv/venv launch mismatch 🐞 Bug ✓ Correctness
• CONTRIBUTING.md documents both “use uv” and “traditional venv” backend setup flows, but the launch command was changed to uv run uvicorn ... unconditionally. • Contributors who follow the traditional venv path (and don’t have uv installed) will hit a “command not found”/workflow dead-end when they reach the launch step. • The repo already documents the correct split (uv run ... vs plain uvicorn ...) in backend/README.md, indicating both workflows are intended to be supported.
Agent Prompt
### Issue description
CONTRIBUTING.md shows two backend setup options (using `uv` vs traditional `python -m venv`), but the backend launch command is now documented only as `uv run uvicorn ...`. This breaks the traditional venv workflow for contributors who don’t have `uv` installed.
### Issue Context
The repository already documents the correct dual-path approach in `backend/README.md` (use `uv run ...` for the `uv` path; use plain `uvicorn ...` for the pip/venv path). CONTRIBUTING.md should match that.
### Fix Focus Areas
- CONTRIBUTING.md[57-103]
- CONTRIBUTING.md[415-423]
### Suggested change
In both CN/EN sections, change the “Launch Dev Servers” backend block to something like:
- If using uv:
- `uv run uvicorn app.main:app --reload --port 8090`
- If using traditional venv (after activating `.venv`):
- `uvicorn app.main:app --reload --port 8090`
Optionally add a short note that `uv` must be installed if choosing the uv workflow.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
|
REPO="datawhalechina/whale-whisper"
PR="25"
# Phase 2: size label (PR Size: S; 45+37=82 lines; 2 files)
gh pr edit "$PR" --repo "$REPO" --add-label "size/S"
# Phase 5: summary review (no inline comments; no issues >= 80 confidence)
SUMMARY=$(cat <<'MD'
## 🤖 Codex PR Review
No significant issues identified in this PR. Documentation updates align with the repository’s current CI/tooling configuration and the configured frontend dev server port.
### PR Size: S
- **Lines changed**: 82
- **Files changed**: 2
### Review Coverage
- [x] Logic and correctness - Clean
- [x] Security (OWASP Top 10) - Clean
- [x] Error handling - Clean
- [x] Type safety - Clean
- [x] Documentation accuracy - Clean
- [x] Test coverage - Adequate
- [x] Code clarity - Good
---
*Automated review by Codex AI*
MD
)
gh pr review "$PR" --repo "$REPO" --comment --body "$SUMMARY" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
将 CONTRIBUTING.md 和 README.md 中的版本要求、仓库 URL、目录结构、命令示例等信息与项目当前实际状态对齐，并补充安全漏洞报告指引。
问题
PR #10 引入的 CONTRIBUTING.md 以及 README.md 中存在多处与项目现状不一致的内容：仓库 URL 仍使用旧大写命名、Python/Node.js/pnpm 版本要求过低、前端端口号和目录结构已变更、后端启动命令未使用
uv run、贡献者徽章指向了错误的仓库。关联 PR：
解决方案
逐项修正文档中的过时信息，使其与 CI 环境和实际项目结构保持同步。
变更内容
核心变更
datawhalechina/WhaleWhisper.git→datawhalechina/whale-whisper.git（CONTRIBUTING.md、README.md 多处）3.8+→3.10+，与backend/pyproject.toml和 CI (3.11) 对齐16+→20+，pnpm8+→9.12.2localhost:5173→localhost:5174uvicorn ...→uv run uvicorn ...frontend/apps/web/、frontend/apps/desktop-tauri/、backend/examples/、backend/scripts/、data/）base-nlp修正为whale-whisper辅助变更
.github/SECURITY.md（中英双语）pnpm run typecheck步骤测试
自测方式
Checklist
由 Claude AI 自动生成