Merged
Conversation
* chore: add comprehensive contributing guide * Update CONTRIBUTING.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
github-actions
bot
added
needs-review
Review Summary by QodoAdd comprehensive bilingual contributing guide
WalkthroughsDescription• Add comprehensive bilingual contributing guide (Chinese/English) • Document development setup, branch naming, and commit conventions • Provide code style guidelines for Python backend and TypeScript/Vue frontend • Include testing procedures, PR workflow, and issue reporting templates Diagramflowchart LR
A["Contributing Guide"] --> B["Chinese Section"]
A --> C["English Section"]
B --> D["Setup Instructions"]
B --> E["Code Style & Testing"]
B --> F["PR & Issue Templates"]
C --> D
C --> E
C --> F
File Changes1. CONTRIBUTING.md
|
Contributor
Greptile OverviewGreptile SummaryAdded comprehensive bilingual (Chinese/English) contributing guide covering all essential aspects of the contribution process. The guide includes detailed setup instructions for backend (Python with Key documentation additions:
Note: This PR itself has an incomplete description (checkboxes not filled) and the title "Dev" doesn't follow the guide's own conventions - should be something like Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| CONTRIBUTING.md | Added comprehensive bilingual contributing guide with setup instructions, branch strategy, commit conventions, code style guidelines, and testing requirements |
Sequence Diagram
sequenceDiagram
participant Contributor
participant LocalRepo as Local Repository
participant GitHub
participant CI as CI/CD Pipeline
participant Maintainer
Contributor->>GitHub: Fork/Clone repository
Contributor->>LocalRepo: git checkout dev
Contributor->>LocalRepo: git pull origin dev
Contributor->>LocalRepo: git checkout -b feature/new-feature
Contributor->>LocalRepo: Make code changes
Contributor->>LocalRepo: Run local tests (backend/frontend)
alt Tests Pass
Contributor->>LocalRepo: git commit -m "feat: description"
Contributor->>GitHub: git push origin feature/new-feature
Contributor->>GitHub: Create PR targeting dev branch
GitHub->>CI: Trigger CI checks
CI->>CI: Run backend tests
CI->>CI: Run frontend tests
CI->>GitHub: Report CI status
alt CI Passes
GitHub->>Maintainer: Notify for review
Maintainer->>GitHub: Review code
alt Approved
Maintainer->>GitHub: Squash and merge to dev
GitHub->>LocalRepo: Update dev branch
else Changes Requested
Maintainer->>Contributor: Request changes
Contributor->>LocalRepo: Make updates
Contributor->>GitHub: Push to same branch
end
else CI Fails
GitHub->>Contributor: Notify CI failure
Contributor->>LocalRepo: Fix issues
end
else Tests Fail
Contributor->>LocalRepo: Fix issues locally
end
Code Review by Qodo
1. Wrong engines.yaml schema
|
![qodo-code-review[bot]](https://avatars.githubusercontent.com/in/484649?s=60&v=4){kind=small}
Comment on lines
+80
to
+89
| 编辑 `backend/config/engines.yaml` 配置 LLM/ASR/TTS 提供商： | ||
|
|
||
| ```yaml | ||
| llm: | ||
| default: openai | ||
| providers: | ||
| openai: | ||
| api_key: "your-api-key" | ||
| model: "gpt-4" | ||
| ``` |
There was a problem hiding this comment.
1. Wrong engines.yaml schema 🐞 Bug ✓ Correctness
• CONTRIBUTING.md shows an engines.yaml structure (providers map + inline api_key) that does not match what the backend actually parses (engines list + api_key_env). • Following the guide will likely result in engines not being registered (or API keys not being picked up), breaking LLM/ASR/TTS at runtime. • It also encourages putting secrets directly into a repo-tracked YAML, which conflicts with the repo’s secret-handling guidance.
Agent Prompt
### Issue description
CONTRIBUTING.md documents an `engines.yaml` format that the backend does not support (`providers` + inline `api_key`). The backend expects `engines` lists and reads keys from `api_key_env`.
### Issue Context
The backend loader (`backend/app/services/engines/loader.py`) only loads `config['...']['engines']` (list) and only reads API keys from `api_key_env`.
### Fix Focus Areas
- CONTRIBUTING.md[78-90]
- CONTRIBUTING.md[397-409]
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
🤖 Codex PR ReviewPR Summary
Key Risks
Findings
|
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.
变更说明
关联 Issue / 需求
自测方式
cd backend && uv run uvicorn app.main:app --reload --port 8090cd frontend && pnpm --filter @whalewhisper/web dev风险 & 回滚
Checklist
PR Checks）通过📝 PR 说明（Codex 自动生成）
CONTRIBUTING.md（中英双语），集中说明项目贡献规范与协作流程：分支命名、Conventional Commits、后端/前端代码风格、提交前测试清单，以及 PR / Issue 提交流程与检查项，降低贡献者上手成本并统一协作标准。CONTRIBUTING.md，确认目录/锚点与中英导航链接可正常跳转、代码块渲染正常。dev、main仅用于发布）。