Skip to content

feat(agent): add AGENTS.md (another version)#2939

Open
pynickle wants to merge 1 commit into
devfrom
feat/agents-md
Open

feat(agent): add AGENTS.md (another version)#2939
pynickle wants to merge 1 commit into
devfrom
feat/agents-md

Conversation

@pynickle

@pynickle pynickle commented May 30, 2026

Copy link
Copy Markdown
Contributor

另开一个,对比一下吧(x

由 Sourcery 提供的摘要

添加 AGENTS.md 知识库,描述项目架构、工作流,以及支持 AI 辅助开发的防护栏。

文档:

  • AGENTS.md 中记录启动器(launcher)的项目结构、构建和 CI 设置,以及关键生命周期概念。
  • AGENTS.md 中为贡献者定义编码约定、分支和提交规范,以及针对 AI 生成代码的相关策略。
  • 阐明操作边界、允许的模式,并引用现有 wiki 资源,以支持更安全的自动化贡献。
Original summary in English

Summary by Sourcery

Add an AGENTS.md knowledge base describing project architecture, workflows, and guardrails for AI-assisted development.

Documentation:

  • Document project structure, build and CI setup, and key lifecycle concepts for the launcher in AGENTS.md.
  • Define coding conventions, branching and commit standards, and AI-generated code policies for contributors in AGENTS.md.
  • Clarify operational boundaries, allowed patterns, and references to existing wiki resources for safer automated contributions.

@pcl-ce-automation pcl-ce-automation Bot added 🛠️ 等待审查 Pull Request 已完善,等待维护者或负责人进行代码审查 size: L PR 大小评估:大型 labels May 30, 2026
@sourcery-ai

sourcery-ai Bot commented May 30, 2026

Copy link
Copy Markdown

审查者指南

新增 AGENTS.md,这是一个项目知识库和 AI 使用指南,记录了解决方案结构、生命周期、编码规范、CI/构建配置、贡献规则,以及 AI 辅助开发的运行边界。

AGENTS.md 中的应用生命周期状态图

stateDiagram-v2
  [*] --> BeforeLoading
  BeforeLoading --> Loading
  Loading --> Loaded
  Loaded --> WindowCreating
  WindowCreating --> WindowCreated
  WindowCreated --> Running
  Running --> Closing
  Closing --> Exiting
  Exiting --> [*]
Loading

文件级变更

变更 详情 文件
引入 AGENTS.md,作为 PCL2-CE 上 AI 辅助开发的集中式知识库。
  • 描述整体项目背景、技术栈、解决方案布局以及应用启动生命周期。
  • 记录编码约定、语言特性、构建配置、CI 矩阵以及测试执行预期。
  • 明确贡献规则,包括提交信息格式、AI 生成代码要求、Git 签名以及分支策略。
  • 定义运行边界,例如禁止使用的 API、非功能性存根、本地化要求以及允许的扩展点。
  • 列出关键文件、CI 环境变量以及指向 wiki 资源的链接,用于进一步查阅文档。
AGENTS.md

提示与命令

与 Sourcery 交互

  • 触发新的审查: 在 pull request 上评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审查评论。
  • 从审查评论生成 GitHub issue: 通过回复某条审查评论,请求 Sourcery 从该评论创建一个 issue。你也可以回复该审查评论 @sourcery-ai issue 来从中创建 issue。
  • 生成 pull request 标题: 在 pull request 标题中的任意位置写上 @sourcery-ai,即可在任何时候生成标题。你也可以在 pull request 上评论 @sourcery-ai title 来(重新)生成标题。
  • 生成 pull request 摘要: 在 pull request 正文中的任意位置写上 @sourcery-ai summary,即可在任意位置生成 PR 摘要。你也可以在 pull request 上评论 @sourcery-ai summary 来在任何时候(重新)生成摘要。
  • 生成审查者指南: 在 pull request 上评论 @sourcery-ai guide,即可在任何时候(重新)生成审查者指南。
  • 解决所有 Sourcery 评论: 在 pull request 上评论 @sourcery-ai resolve,即可解决所有 Sourcery 评论。如果你已经处理完所有评论且不想再看到它们,这将非常有用。
  • 撤销所有 Sourcery 审查: 在 pull request 上评论 @sourcery-ai dismiss,即可撤销所有现有的 Sourcery 审查。如果你希望从一个全新的审查开始,这尤其有用——别忘了再评论 @sourcery-ai review 来触发新的审查!

自定义你的使用体验

访问你的控制面板 以:

  • 启用或禁用审查功能,例如 Sourcery 自动生成的 pull request 摘要、审查者指南等。
  • 更改审查语言。
  • 添加、删除或编辑自定义审查指令。
  • 调整其他审查设置。

获取帮助

Original review guide in English

Reviewer's Guide

Adds AGENTS.md, a project knowledge base and AI usage guide that documents solution structure, lifecycle, coding standards, CI/build setup, contribution rules, and operational boundaries for AI-assisted development.

State diagram for application lifecycle in AGENTS.md

stateDiagram-v2
  [*] --> BeforeLoading
  BeforeLoading --> Loading
  Loading --> Loaded
  Loaded --> WindowCreating
  WindowCreating --> WindowCreated
  WindowCreated --> Running
  Running --> Closing
  Closing --> Exiting
  Exiting --> [*]
Loading

File-Level Changes

Change Details Files
Introduce AGENTS.md as a centralized knowledge base for AI-assisted development on PCL2-CE.
  • Describe overall project context, tech stack, solution layout, and application startup lifecycle.
  • Document coding conventions, language features, build configurations, CI matrix, and test execution expectations.
  • Specify contribution rules including commit format, AI-generated code requirements, Git signing, and branching strategy.
  • Define operational boundaries such as forbidden APIs, non-functional stubs, localization requirements, and allowed extension points.
  • List key files, CI environment variables, and links to wiki resources for deeper documentation.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - 我已经查看了你的更改,看起来非常棒!


Sourcery 对开源项目是免费的——如果你喜欢我们的审查结果,请考虑分享 ✨
帮我变得更有用!请在每条评论上点 👍 或 👎,我会根据你的反馈来改进后续的审查。
Original comment in English

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@pynickle pynickle changed the title feat(agent): add AGENTS.md feat(agent): add AGENTS.md (another version) May 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: L PR 大小评估:大型 🛠️ 等待审查 Pull Request 已完善,等待维护者或负责人进行代码审查

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant