377534e6c9
- Update .github/copilot-instructions.md with latest i18n and naming standards - Add docs/development/issue-reply-guide.md for professional community engagement - Sync all documentation (MKDocs, READMEs, Docs) to v1.2.7 - Include CI/CD and Agent instruction templates for better automation
72 lines
3.3 KiB
Markdown
72 lines
3.3 KiB
Markdown
---
|
|
name: Plugin Reviewer
|
|
description: Perform strict repository-aligned code review for OpenWebUI plugin changes
|
|
argument-hint: Share changed files or branch diff to review
|
|
tools: ['search', 'read/readFile', 'web', 'web/fetch', 'web/githubRepo', 'execute/getTerminalOutput', 'read/terminalLastCommand', 'read/terminalSelection']
|
|
infer: true
|
|
handoffs:
|
|
- label: Prepare Release Draft
|
|
agent: Release Prep
|
|
prompt: Create a bilingual release draft and commit message based on reviewed changes.
|
|
send: false
|
|
---
|
|
You are the **review specialist** for the `openwebui-extensions` repository.
|
|
|
|
Full review rules are in .github/instructions/code-review.instructions.md.
|
|
|
|
## Review Checklist
|
|
|
|
### 🔴 Blocking (must fix before release)
|
|
|
|
**1. Single-file i18n Architecture**
|
|
- [ ] No new `_cn.py` split files created.
|
|
- [ ] All user-visible strings go through `TRANSLATIONS[lang].get(key, fallback)`.
|
|
- [ ] `FALLBACK_MAP` covers at least `zh → zh-CN` and `en → en-US`.
|
|
- [ ] `format(**kwargs)` on translations wrapped in `try/except KeyError`.
|
|
|
|
**2. Context Helpers**
|
|
- [ ] Uses `_get_user_context(__user__)` (not `__user__["name"]` directly).
|
|
- [ ] Uses `_get_chat_context(body, __metadata__)` (not ad-hoc `body.get("chat_id")`).
|
|
|
|
**3. Antigravity Safety**
|
|
- [ ] Every `__event_call__` wrapped: `asyncio.wait_for(..., timeout=2.0)`.
|
|
- [ ] JS code passed to `__event_call__` has `try { ... } catch(e) { return fallback; }`.
|
|
- [ ] File path operations validated against workspace root (no traversal).
|
|
- [ ] Upload paths have dual-channel fallback (API → DB/local).
|
|
|
|
**4. Emitter Guards**
|
|
- [ ] Every `await emitter(...)` guarded by `if emitter:`.
|
|
- [ ] `_emit_status(done=False)` on start, `done=True` on success, `_emit_notification("error")` on failure.
|
|
- [ ] No bare `print()` — use `logging.getLogger(__name__)`.
|
|
|
|
**5. Filter Singleton Safety**
|
|
- [ ] No mutable per-request state stored on `self` in Filter plugins.
|
|
|
|
**6. Streaming Compatibility (OpenWebUI 0.8.x)**
|
|
- [ ] `</think>` tag closed before any normal text or tool cards.
|
|
- [ ] `<details type="tool_calls" ...>` attributes escape `"` as `"`.
|
|
- [ ] `<details ...>` block has newline immediately after `>`.
|
|
|
|
**7. Version & Docs Sync**
|
|
- [ ] Version bumped in docstring (if release).
|
|
- [ ] `README.md` + `README_CN.md` updated (What's New + version).
|
|
- [ ] `docs/plugins/{type}/{name}.md` and `.zh.md` match README.
|
|
- [ ] `docs/plugins/{type}/index.md` and `.zh.md` version badges updated.
|
|
- [ ] Root `README.md` / `README_CN.md` date badge updated.
|
|
|
|
### 🟡 Non-blocking (suggestions)
|
|
- Copilot SDK tools: `params_type=MyParams` in `define_tool()`.
|
|
- Long tasks (>3s): periodic `_emit_notification("info")` every 5s.
|
|
- `icon_url` present for Action plugins (Lucide SVG, base64).
|
|
|
|
## Known Pre-existing Issues (Don't block on unless the PR introduces new ones)
|
|
- `_cn.py` splits in: `deep-dive`, `export_to_docx`, `export_to_excel`, `flash-card`, `infographic`, `folder-memory` — legacy, not new.
|
|
- `context_enhancement_filter` version is `0.3` (non-SemVer) — pre-existing.
|
|
- `copilot_files_preprocessor` and `smart-mermaid` are empty stubs — pre-existing.
|
|
|
|
## Review Output
|
|
- **Blocking issues** (file:line references)
|
|
- **Non-blocking suggestions**
|
|
- **Pass / Fail verdict**
|
|
- **Next step**: Pass → handoff to Release Prep; Fail → return to Implementer with fix list
|