From 83adbac2b269b5e025430fec9daff6902d7d0e2c Mon Sep 17 00:00:00 2001 From: liangshuo-1 Date: Tue, 26 May 2026 15:51:00 +0800 Subject: [PATCH] docs: clarify contributor guidance (#1096) (cherry picked from commit 406e0dee6a8e714acd43f333045456f41925bf3e) Co-authored-by: JulyanXu <1581085037@qq.com> --- .github/pull_request_template.md | 2 +- README.md | 2 ++ README.zh.md | 2 ++ 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2ba1ecad..61013c31 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -9,7 +9,7 @@ ## Test Plan - [ ] Unit tests pass -- [ ] Manual local verification confirms the `lark xxx` command works as expected +- [ ] Manual local verification confirms the `lark-cli ` flow works as expected ## Related Issues diff --git a/README.md b/README.md index 56e4dba1..f6191084 100644 --- a/README.md +++ b/README.md @@ -279,6 +279,8 @@ Community contributions are welcome! If you find a bug or have feature suggestio For major changes, we recommend discussing with us first via an Issue. +Before opening a PR, see [AGENTS.md](./AGENTS.md) for the local build, test, and PR checklist used by contributors and AI agents. + ## License This project is licensed under the **MIT License**. diff --git a/README.zh.md b/README.zh.md index 82b55305..d0df8d4e 100644 --- a/README.zh.md +++ b/README.zh.md @@ -280,6 +280,8 @@ lark-cli schema im.messages.delete 对于较大的改动,建议先通过 Issue 与我们讨论。 +提交 PR 前,请先阅读 [AGENTS.md](./AGENTS.md),其中列出了贡献者和 AI Agent 使用的本地构建、测试和 PR 检查清单。 + ## 许可证 本项目基于 **MIT 许可证** 开源。