mirror of
https://github.com/QwenLM/qwen-code.git
synced 2026-05-03 14:10:43 +00:00
e47b22806b
Some checks are pending
Qwen Code CI / CodeQL (push) Waiting to run
Qwen Code CI / Lint (push) Waiting to run
Qwen Code CI / Test (push) Blocked by required conditions
Qwen Code CI / Test-1 (push) Blocked by required conditions
Qwen Code CI / Test-2 (push) Blocked by required conditions
Qwen Code CI / Test-3 (push) Blocked by required conditions
Qwen Code CI / Test-4 (push) Blocked by required conditions
Qwen Code CI / Test-5 (push) Blocked by required conditions
Qwen Code CI / Test-6 (push) Blocked by required conditions
Qwen Code CI / Test-7 (push) Blocked by required conditions
Qwen Code CI / Test-8 (push) Blocked by required conditions
Qwen Code CI / Post Coverage Comment (push) Blocked by required conditions
E2E Tests / E2E Test (Linux) - sandbox:docker (push) Waiting to run
E2E Tests / E2E Test (Linux) - sandbox:none (push) Waiting to run
E2E Tests / E2E Test - macOS (push) Waiting to run
- Add new skills: bugfix, feat-dev with structured workflows - Update existing skills: docs-audit-and-refresh, docs-update-from-diff, e2e-testing, qwen-code-claw, structured-debugging, terminal-capture - Update test-engineer agent with clearer constraints and formatting - Update qc commands: bugfix, code-review, commit, create-issue, create-pr - Reorganize .gitignore to keep qwen configs near top - Expand AGENTS.md with development commands, feature/bugfix workflows, project directories table, and code review guidelines Co-authored-by: 愚远 <zhenxing.tzx@alibaba-inc.com> Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com>
45 lines
1.8 KiB
Markdown
45 lines
1.8 KiB
Markdown
# Audit Checklist
|
|
|
|
Use this checklist to keep repository-wide documentation audits focused and
|
|
repeatable.
|
|
|
|
## High-signal repository surfaces
|
|
|
|
- `packages/cli/**` Inspect commands, flows, prompts, flags, and CLI-facing
|
|
behavior.
|
|
- `packages/core/**` Inspect shared behavior, settings, tools, provider
|
|
integration, and feature semantics.
|
|
- `packages/sdk-typescript/**` and `packages/sdk-java/**` Inspect SDK setup,
|
|
usage, and examples that may affect developer docs.
|
|
- `packages/vscode-ide-companion/**`, `packages/zed-extension/**`, and related
|
|
integration packages Inspect IDE and extension behavior that should be
|
|
reflected in user docs.
|
|
- `docs/**/_meta.ts` Inspect navigation completeness after creating or moving
|
|
pages.
|
|
|
|
## Gap detection prompts
|
|
|
|
Ask these questions while comparing the repo to `docs/`:
|
|
|
|
- Does a visible feature exist in code but have no page or section in `docs/`?
|
|
- Does a docs page mention a command, setting, provider, or path that no longer
|
|
exists?
|
|
- Do examples still match the current repository layout and command syntax?
|
|
- Is a page present but hidden or missing from `_meta.ts`?
|
|
- Do multiple pages describe the same feature inconsistently?
|
|
|
|
## Common drift patterns
|
|
|
|
- Renamed settings keys or changed defaults
|
|
- Updated authentication or provider configuration flow
|
|
- New or removed CLI commands and flags
|
|
- New tool behavior or approval/sandbox semantics
|
|
- IDE integration changes that never reached the docs
|
|
- Features documented in the wrong section, making them hard to find
|
|
|
|
## Output standard
|
|
|
|
- Prefer a small number of precise edits over a speculative docs rewrite.
|
|
- Leave a clear summary of what was missing, wrong, or stale.
|
|
- If the audit uncovers a larger docs reorganization, fix the highest-impact
|
|
inaccuracies first and note the remaining work.
|