feat(agents): add AGENTS.md file#2932
Open
tangge233 wants to merge 3 commits into
Open
Conversation
审阅者指南添加了一份完整的 AI 代理贡献与审阅流程图flowchart TD
Agent[AI_agent generates_code]
CommitRules[Check_AI_generation_rules]
HumanReview[Human_reviewer_audits_code]
Tests[Run_dotnet_test]
Checklist[Run_pre_commit_checklist]
PR[Open_PR_with_tag]
Agent --> CommitRules
CommitRules -->|OK| HumanReview
CommitRules -->|Violates_size_or_scope_limits| Agent
HumanReview -->|Issues_found| Agent
HumanReview -->|Looks_good| Tests
Tests -->|Tests_fail| Agent
Tests -->|Tests_pass| Checklist
Checklist -->|All_checks_pass| PR
Checklist -->|Missing_items| Agent
文件级变更
技巧与命令与 Sourcery 交互
自定义使用体验访问你的 控制面板 以:
获取帮助Original review guide in EnglishReviewer's GuideAdds a comprehensive AGENTS.md guideline document describing coding, architecture, workflow, and review conventions for AI agents contributing to the PCL2-CE project. Flow diagram for AI agent contribution and review processflowchart TD
Agent[AI_agent generates_code]
CommitRules[Check_AI_generation_rules]
HumanReview[Human_reviewer_audits_code]
Tests[Run_dotnet_test]
Checklist[Run_pre_commit_checklist]
PR[Open_PR_with_tag]
Agent --> CommitRules
CommitRules -->|OK| HumanReview
CommitRules -->|Violates_size_or_scope_limits| Agent
HumanReview -->|Issues_found| Agent
HumanReview -->|Looks_good| Tests
Tests -->|Tests_fail| Agent
Tests -->|Tests_pass| Checklist
Checklist -->|All_checks_pass| PR
Checklist -->|Missing_items| Agent
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - 我在这里给出了一些总体反馈:
- “工具和环境”部分中的工具和运行时版本与前面提到的 .NET 8 描述存在冲突(例如 .NET SDK 10.0、Rider 2025.3.2、VS 2026)。建议将这些版本与当前项目的实际要求保持一致,或者明确标注为示例。
- 由于本指南的很多部分与通用项目规范(命名、提交信息、生命周期服务等)存在重复,建议显式引用或链接到权威的编码规范/wiki,并说明哪些内容是针对 AI 代理(AI agents)的特定要求,以减少今后各文档之间的偏差。
AI 代理提示词
Please address the comments from this code review:
## Overall Comments
- The tooling and runtime versions in the "工具和环境" section conflict with the earlier .NET 8 description (e.g., .NET SDK 10.0, Rider 2025.3.2, VS 2026), so it would be good to align these with the actual current project requirements or clearly mark them as examples.
- Since many parts of this guide duplicate general project rules (naming, commit messages, lifecycle services, etc.), consider explicitly referencing or linking to the canonical coding standards/wiki and clarifying which parts are AI-agent-specific to reduce future drift between documents.帮我变得更有用!请在每条评论上点击 👍 或 👎,我会根据你的反馈改进后续评审。
Original comment in English
Hey - I've left some high level feedback:
- The tooling and runtime versions in the "工具和环境" section conflict with the earlier .NET 8 description (e.g., .NET SDK 10.0, Rider 2025.3.2, VS 2026), so it would be good to align these with the actual current project requirements or clearly mark them as examples.
- Since many parts of this guide duplicate general project rules (naming, commit messages, lifecycle services, etc.), consider explicitly referencing or linking to the canonical coding standards/wiki and clarifying which parts are AI-agent-specific to reduce future drift between documents.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The tooling and runtime versions in the "工具和环境" section conflict with the earlier .NET 8 description (e.g., .NET SDK 10.0, Rider 2025.3.2, VS 2026), so it would be good to align these with the actual current project requirements or clearly mark them as examples.
- Since many parts of this guide duplicate general project rules (naming, commit messages, lifecycle services, etc.), consider explicitly referencing or linking to the canonical coding standards/wiki and clarifying which parts are AI-agent-specific to reduce future drift between documents.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Contributor
|
|
pynickle
requested changes
May 30, 2026
LuLu-ling
requested changes
May 30, 2026
Contributor
Author
这个比较麻烦了,GitHub MCP 无法直接访问 Wiki,目前 API 相关的文档都在 Wiki 板块下。等之后把再把 API 文档迁移到仓库的 /docs 里吧 |
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
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.
先出一版不太行的,等大佬来优化下
由 Sourcery 提供的摘要
文档:
AGENTS.md,描述由 AI 生成贡献所需遵循的编码规范、项目结构、提交约定、测试要求、性能要求、安全要求以及代码审查要求。Original summary in English
Summary by Sourcery
Documentation: