mirror of
https://github.com/QwenLM/qwen-code.git
synced 2026-07-10 01:29:17 +00:00
7cb017d4b0
* docs(agents): add Working Principles and file/comment conventions Add a "Working Principles" section at the top of AGENTS.md, with Simplicity First (adapted from Andrej Karpathy's CLAUDE.md) as the lead principle. Extend Code Conventions with two new entries: - File naming: PascalCase for React components, kebab-case preferred for new non-component files, existing camelCase stays as-is. - Comments: default to none; explain why, not what. Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com> * docs(agents): link Karpathy's CLAUDE.md in attribution Per review feedback, make the source attribution clickable so reviewers can reach the original document in one hop. Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com> * docs(agents): align comments guidance — "default to none" Raise the bar for code comments from "add sparingly" to "default to none" in the runtime prompt, matching the AGENTS.md convention. Add a preservation clause to AGENTS.md so agents do not strip existing high-value comments during cleanup passes. Update snapshots. Co-Authored-By: Qwen Code <noreply@alibaba-inc.com> * docs(pr-template): restructure for reviewer test plan clarity - Reorganize PR template around a Reviewer Test Plan section with How to verify, Before/After, and Tested on - Add collapsible Chinese description section for bilingual PRs - Simplify create-pr command guidance to match the new template - Tighten AGENTS.md file naming and comments conventions; align PR submission guide with the new template This makes PRs easier to review by focusing contributors on the evidence reviewers need most. * docs(pr-template): merge Before/After into Evidence and require full Chinese translation - Consolidate Before and After sections into a single Evidence (Before & After) section - Update Chinese summary comment to require full paragraph-by-paragraph translation instead of abbreviated bullets This reduces template redundancy for non-UI changes and ensures the Chinese block is a proper translation, not a summary. --------- Co-authored-by: Qwen-Coder <qwen-coder@alibabacloud.com> Co-authored-by: Qwen Code <noreply@alibaba-inc.com>
66 lines
2 KiB
Markdown
66 lines
2 KiB
Markdown
<!--
|
||
Maintainers prioritize PRs with a clear reviewer test plan — without it, review may be delayed.
|
||
|
||
Don't hard-wrap paragraphs: GitHub renders single newlines as <br>, so wrapped text shows as a narrow column. Write each paragraph or list item as one long line.
|
||
-->
|
||
|
||
## What this PR does
|
||
|
||
<!-- What this PR does. Describe the change in prose, not by file or function names. -->
|
||
|
||
## Why it's needed
|
||
|
||
<!-- Why it's needed: the motivation, the problem being solved, or the user-facing benefit. -->
|
||
|
||
## Reviewer Test Plan
|
||
|
||
<!--
|
||
How a reviewer can confirm this PR: reproduction steps, expected vs observed behavior, and evidence. CI runs on macOS, Windows, and Linux — Tested on is what you verified locally.
|
||
|
||
User-visible / TUI: Before/After with tmux-real-user-testing skill, screenshots, or a short recording.
|
||
Non–user-visible (refactor, types, docs): commands and output below; write N/A under Before/After.
|
||
-->
|
||
|
||
### How to verify
|
||
|
||
<!-- How you reproduced it and what a reviewer should confirm — steps if needed, expected vs observed behavior. Focus on outcomes; paste logs or test output when helpful. -->
|
||
|
||
### Evidence (Before & After)
|
||
|
||
<!-- User-visible / TUI changes: paste before-and-after screenshots, tmux logs, or video side by side. Non-UI changes (docs, refactor, types): N/A -->
|
||
|
||
### Tested on
|
||
|
||
| OS | Status |
|
||
| :--------: | :----: |
|
||
| 🍏 macOS | |
|
||
| 🪟 Windows | |
|
||
| 🐧 Linux | |
|
||
|
||
<!-- ✅ tested · ⚠️ not tested · N/A -->
|
||
|
||
### Environment (optional)
|
||
|
||
<!-- Local runtime: e.g. npm run dev, Docker/Podman sandbox, seatbelt. N/A if only unit tests. -->
|
||
|
||
## Risk & Scope
|
||
|
||
- Main risk or tradeoff:
|
||
- Not validated / out of scope:
|
||
- Breaking changes / migration notes:
|
||
|
||
## Linked Issues
|
||
|
||
<!--
|
||
Closes #N / Fixes #N / Resolves #N to auto-close.
|
||
Otherwise reference without a closing keyword.
|
||
-->
|
||
|
||
<details>
|
||
<summary>中文说明</summary>
|
||
|
||
<!--
|
||
完整翻译上面的英文正文，逐段对应，不要省略或缩写。PR 标题保持英文。
|
||
-->
|
||
|
||
</details>
|