AGENTS.md@frontend/packages/reactA
AGENTS.md@frontend/packages/react from volcengine/openviking is an AGENTS.md file: the standing instructions coding agents read in that repo.
mdr add volcengine/openviking/frontend/packages/react/AGENTS.md@git:20261105.2fc2f72Pins git:20261105.2fc2f72 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 14 of 14 checks passed
- Kind
- AGENTS.md file
- Repository
- volcengine/openviking
- Path
frontend/packages/react/AGENTS.md- Versions recorded
- 3
- Latest version
- git:20261105.2fc2f72, committed Nov 5, 2026
- First version recorded
- Nov 4, 2026
- Size
- 5,178 bytes
- Repository stars
- 41,589
- License
- AGPL-3.0
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# React Agent Guide 适用于 `frontend/packages/react/**`，同时遵循 [Frontend Agent Guide](../../AGENTS.md) 和更深目录的规则。 ## 公开导出 - 目录以 `index.ts` 作为唯一出口，包根入口 `src/index.ts` 只从这里取。 - 根入口只导出各组件、各业务模块的组件本体与主 Props 类型（`<组件名>Props`），作为最常用的快捷方式。 - 子类型、回调参数类型、行与选项等数据结构、句柄与文案包，一律只从 `components/<组件>`、`modules/<模块>` 子路径导出。根入口不聚合它们。 - 依赖可选 peer 的组件不进入根入口：`FilePreview` 的类型引用 `@ark-design/ui`，放进根声明会让该可选 peer 对只用其他根导出的消费者变成必需。 - 新增或调整导出时，同步维护 `package.json` 的 `exports`、Rslib 入口与声明路径，并从真实打包产物验证根入口与各子路径都能解析。 ## useEffect 使用门槛 - 新增或修改组件、自定义 Hook 时，非必要不使用 `useEffect`。只有需要在渲染提交后，将组件与明确的外部系统保持同步，且更直接的声明式 API、事件处理或已有专用 Hook 无法满足时，才允许使用。 - 外部系统包括浏览器订阅、非 React 控件和网络服务；组件内部的 props、state 及其派生值不是外部系统。“挂载后执行”“依赖变化时执行”或“只运行一次”本身不能证明必要性。 - 不得通过改名、封装自定义 Hook 或替换为 `useLayoutEffect` 绕过本规则。按 React 官方的 [You Might Not Need an Effect](https://react.dev/learn/you-might-not-need-an-effect) 判断是否可以移除 Effect。 ## 优先选择替代方式 | 场景 | 应采用的方式 | …
Read the whole file at its exact version.
How to install
mdr add volcengine/openviking/frontend/packages/react/AGENTS.md@sha256:088ecbbf55ee7cdeThe line at the top of this page pins the label git:20261105.2fc2f72, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_5kojgjbgdrxhf42y)
0 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Nov 4, 2026 and Nov 5, 2026, more than one a day.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261105.2fc2f72 latest | 2026-11-05 | 2fc2f72 | 5,178 B | A | view · diff |
| git:20261104.0b713a5 | 2026-11-04 | 0b713a5 | 4,379 B | A | view · diff |
| git:20261104.e6437c9 | 2026-11-04 | e6437c9 | 4,359 B | A | view |
Audit of the latest version
- pass: Size between 200 bytes and 200 KB (5178 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
volcengine/openviking · 41,589 stars · license AGPL-3.0 · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5kojgjbgdrxhf42y GET https://markdownregistry.com/api/v1/resolve?ref=volcengine/openviking/frontend/packages/react/AGENTS.md GET https://markdownregistry.com/api/v1/blob/088ecbbf55ee7cdeaef21dc4a3ebbb9a3a3b9a7bbf928f1e4bd6ba9d93a610bc
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: how to write a good AGENTS.md · AGENTS.md vs CLAUDE.md · which agent file does what.