更新贡献指南与代理文档

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>

Author: CodeCasterX

AGENTS.en.md

@@ -0,0 +1,41 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+
+This repo hosts the FIT framework and related engines.
+- `framework/` contains the core implementations (`framework/fit/java`, `framework/fit/python`, `framework/waterflow`, `framework/fel`).
+- `docs/` holds user guides, quick starts, and white papers.
+- `examples/` contains runnable samples for FIT and FEL.
+- `docker/` provides container build assets.
+- `build/` is the Maven build output (generated).
+
+## Build, Test, and Development Commands
+
+- `mvn clean install` (repo root): builds all modules and runs tests; outputs to `build/`.
+- `cd framework/fit/java && mvn clean install`: builds the Java FIT framework only.
+- `./build/bin/fit start`: starts the Java runtime (uses Node.js); default port `8080`.
+- `./.claude/run-test.sh`: full CI-like flow (build, start, health checks).
+
+## Coding Style & Naming Conventions
+
+- Java formatting uses the IntelliJ profile `CodeFormatterFromIdea.xml`.
+- Public/protected Java APIs require Javadoc with `@param`/`@return` tags.
+- Class headers must include `@author` and `@since yyyy-MM-dd`.
+- Branch naming follows module prefixes and intent, e.g. `fit-feature-xxx`, `waterflow-bugfix-yyy`.
+
+## Testing Guidelines
+
+- Java tests run via Maven (Surefire); `mvn clean install` is the baseline.
+- Run targeted module tests from their module directory when iterating.
+- Keep tests close to source modules; name tests with `*Test` where applicable.
+
+## Commit & Pull Request Guidelines
+
+- Commit messages use a module tag in brackets and a short Chinese summary, e.g. `[fit] 修复某问题`.
+- Keep commit subjects concise (around 20 characters); add details in the body if needed.
+- PRs should be based on the correct module/version branch and normally include a single commit.
+
+## Security & Configuration Tips
+
+- Do not report vulnerabilities via public issues; follow `SECURITY.md`.
+- Ensure git hooks are enabled for encoding checks (`git-hooks/check-utf8-encoding.sh`).

AGENTS.md

@@ -0,0 +1,41 @@
+# 仓库指南
+
+## 项目结构与模块划分
+
+本仓库包含 FIT 框架及相关引擎。
+- `framework/` 为核心实现目录（`framework/fit/java`、`framework/fit/python`、`framework/waterflow`、`framework/fel`）。
+- `docs/` 存放用户指南、快速入门与白皮书。
+- `examples/` 包含 FIT/FEL 可运行示例。
+- `docker/` 提供容器构建资源。
+- `build/` 为 Maven 构建产物输出目录（自动生成）。
+
+## 构建、测试与开发命令
+
+- `mvn clean install`（仓库根目录）：构建全部模块并运行测试，产物输出到 `build/`。
+- `cd framework/fit/java && mvn clean install`：仅构建 Java FIT 框架。
+- `./build/bin/fit start`：启动 Java 运行时（依赖 Node.js）；默认端口 `8080`。
+- `./.claude/run-test.sh`：完整验证流程（构建、启动、健康检查）。
+
+## 编码风格与命名规范
+
+- Java 格式化使用 IntelliJ 配置 `CodeFormatterFromIdea.xml`。
+- 公共/受保护的 Java API 需要 Javadoc，并包含 `@param`/`@return`。
+- 类头需包含 `@author` 与 `@since yyyy-MM-dd`。
+- 分支命名使用模块前缀与意图，例如 `fit-feature-xxx`、`waterflow-bugfix-yyy`。
+
+## 测试规范
+
+- Java 测试通过 Maven（Surefire）执行，`mvn clean install` 为基线命令。
+- 迭代时可在模块目录运行定向测试。
+- 测试与源码同模块放置，命名优先使用 `*Test`。
+
+## 提交与 PR 规范
+
+- 提交信息以模块标签开头，中文简述，例如 `[fit] 修复某问题`。
+- 标题建议 20 字左右，必要时在正文补充细节。
+- PR 基于正确的模块/版本分支，通常仅包含一次提交。
+
+## 安全与配置提示
+
+- 安全问题请勿在公共 Issue 报告，按 `SECURITY.md` 指引私下提交。
+- 请启用 git hooks 进行编码检查（`git-hooks/check-utf8-encoding.sh`）。

CONTRIBUTING.md

@@ -86,11 +86,10 @@ exec git-hooks/check-utf8-encoding.sh
 
 ### 提交信息格式
 
-- 以中括号开头，然后加上模块名，例如 `[fit]`。
 - 用简短的语句描述提交的主要内容，不要太长，建议 20 个字以内，需要使用中文，结尾不需要句号。
 - 如有必要，在简短的描述后添加一个空行，然后补充详细说明，可以使用多行来描述。
 - 说明中可以包括问题的原因、解决方法和影响范围等。
-- 样例：`[fit] 修复某问题`。
+- 样例：`修复某问题`。
 
 ## 代码审查
 

README.md

@@ -101,9 +101,7 @@ build/
 **启动命令**
 
 ```
-mkdir dynamic-plugins
-cd dynamic-plugins
-../build/bin/fit start
+./build/bin/fit start
 ```
 
 > 以上编译构建出的 `fit` 命令可以通过系统操作（别名或添加系统路径）来简化输入。