docs(guide): 添加仓库开发指南文档

[GeWuYou]

• 创建了项目结构和模块组织说明
• 添加了构建测试和开发命令指南
• 定义了代码风格和命名约定规范
• 提供了测试指南和最佳实践
• 包含了提交和拉取请求准则
• 记录了解决方案文件和目录布局说明

Summary by Sourcery

添加一份面向贡献者的仓库指南文档，描述项目结构和开发工作流。

文档内容：

• 记录解决方案结构、模块组织方式，以及测试、文档和脚本的位置。
• 概述该仓库的标准构建、测试和文档开发命令。
• 定义 C# 代码的编码风格、命名约定，以及命名空间与文件夹对齐的要求。
• 描述测试实践，包括测试框架、项目结构和覆盖率期望。
• 规定贡献者应遵循的提交信息规范和 Pull Request 要求。

Original summary in English

Summary by Sourcery

Add a contributor-facing repository guidelines document describing project layout and development workflows.

Documentation:

• Document the solution structure, module organization, and locations of tests, docs, and scripts.
• Outline standard build, test, and documentation development commands for the repository.
• Define coding style, naming conventions, and namespace-folder alignment expectations for C# code.
• Describe testing practices, including test frameworks, project layout, and coverage expectations.
• Specify commit message conventions and pull request expectations for contributors.

[sourcery-ai]

审阅者指南

添加一个新的仓库指导文档 AGENTS.md，用于说明 .NET 解决方案的布局、标准的构建/测试/开发命令、编码与命名约定、测试实践，以及为贡献者准备的提交/PR 指南。

文件级变更

Change	Details	Files
Document project structure and module layout for the .NET solution.	将 GFramework.sln 描述为该解决方案的入口点。 列出核心运行时项目、它们的抽象对应项目，以及 Roslyn 源代码生成器项目。 解释测试项目如何与运行时模块一一对应，以及文档、Godot 模板和脚本分别位于何处。	AGENTS.md
Describe build, test, and development workflows and commands.	添加针对整个解决方案的标准 dotnet build 和 dotnet test 命令，以及用于聚焦测试的命令。 记录 CI 使用的命名校验脚本。 提供安装依赖项并运行本地 VitePress 文档站点的命令。	AGENTS.md
Define coding style, naming conventions, and testing guidelines for contributors.	指定 C# 格式化规则、nullable/implicit using 设置，以及类型、字段和局部变量的命名模式。 要求命名空间与文件夹结构保持一致，并且每个文件只包含一个 public 类型。 说明基于 NUnit 和 Moq 的测试模式、测试文件的命名约定，以及测试代码目录与生产代码目录的一一对应关系。	AGENTS.md
Establish commit message and pull request guidelines.	记录仓库中使用的 Conventional Commit 风格示例。 鼓励小而聚焦的提交，并使用祈使语态的提交信息。 概述对 PR 描述的期望，包括动机、实现细节、验证步骤，以及在适用时提供截图。	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 摘要、审阅者指南等审阅功能。
• 更改审阅语言。
• 添加、移除或编辑自定义审阅说明。
• 调整其他审阅设置。

获取帮助

• 如有问题或反馈，请联系我们的支持团队。
• 访问我们的文档以获取详细指南和信息。
• 通过关注我们的 X/Twitter、LinkedIn 或 GitHub 与 Sourcery 团队保持联系。

Original review guide in English

Reviewer's Guide

Adds a new AGENTS.md repository guidelines document that documents the .NET solution layout, standard build/test/dev commands, coding and naming conventions, testing practices, and commit/PR guidelines for contributors.

File-Level Changes

Change	Details	Files
Document project structure and module layout for the .NET solution.	Describe GFramework.sln as the entry point for the solution. List core runtime projects, their abstraction counterparts, and Roslyn source generator projects. Explain how test projects mirror runtime modules and where docs, Godot templates, and scripts live.	AGENTS.md
Describe build, test, and development workflows and commands.	Add standard dotnet build and test commands for the full solution and focused tests. Document the naming validation script used by CI. Provide commands to install dependencies and run the local VitePress docs site.	AGENTS.md
Define coding style, naming conventions, and testing guidelines for contributors.	Specify C# formatting rules, nullable/implicit using settings, and naming patterns for types, fields, and locals. Require namespace-folder alignment and one public type per file. Explain NUnit- and Moq-based testing patterns, naming conventions for test files, and directory parity with production code.	AGENTS.md
Establish commit message and pull request guidelines.	Document Conventional Commit style examples used in the repository. Encourage small, scoped commits with imperative messages. Outline expectations for PR descriptions, including motivation, implementation details, validation steps, and screenshots when applicable.	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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[deepsource-io]

DeepSource Code Review

We reviewed changes in 108bcbf...ccb5179 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade

Security   Reliability   Complexity   Hygiene

Code Review Summary

Analyzer	Status	Updated (UTC)	Details
C#		Mar 20, 2026 12:24a.m.	Review ↗
Secrets		Mar 20, 2026 12:24a.m.	Review ↗

[sourcery-ai]

Hey - 我发现了 1 个问题

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="AGENTS.md" line_range="39" />
<code_context>
+
+## Commit & Pull Request Guidelines
+
+Recent history follows Conventional Commit style such as `feat(events): ...`, `refactor(localization): ...`,
+`docs(guide): ...`, and `test(localization): ...`. Keep commits scoped and imperative. PRs should explain the
+motivation, implementation, and validation commands run; link related issues; and include screenshots when docs, UI, or
</code_context>
<issue_to_address>
**nitpick (typo):** 建议使用更规范的名称 "Conventional Commits"，而不是 "Conventional Commit"。

由于这里指的是 Conventional Commits 规范，建议表述为 "Conventional Commits style"，例如："Recent history follows Conventional Commits style such as ..."。

```suggestion
Recent history follows Conventional Commits style such as `feat(events): ...`, `refactor(localization): ...`,
```
</issue_to_address>

---

Sourcery 对开源项目是免费的——如果你觉得我们的评审有帮助，欢迎分享 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{帮我变得更有用！请在每条评论上点 👍 或 👎，我会根据你的反馈改进后续的评审。}

Original comment in English

Hey - I've found 1 issue

Prompt for AI Agents

Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="AGENTS.md" line_range="39" />
<code_context>
+
+## Commit & Pull Request Guidelines
+
+Recent history follows Conventional Commit style such as `feat(events): ...`, `refactor(localization): ...`,
+`docs(guide): ...`, and `test(localization): ...`. Keep commits scoped and imperative. PRs should explain the
+motivation, implementation, and validation commands run; link related issues; and include screenshots when docs, UI, or
</code_context>
<issue_to_address>
**nitpick (typo):** Consider using the standard name "Conventional Commits" instead of "Conventional Commit".

Since this refers to the Conventional Commits specification, consider phrasing it as "Conventional Commits style," e.g., "Recent history follows Conventional Commits style such as ..."

```suggestion
Recent history follows Conventional Commits style such as `feat(events): ...`, `refactor(localization): ...`,
```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}