docs: simplify lark base create guidance#459
docs: simplify lark base create guidance#459kongenpei wants to merge 5 commits intolarksuite:mainfrom
Conversation
There was a problem hiding this comment.
kongenpei has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe changes update documentation for Lark Base creation workflows, clarifying default table behavior, adding deletion decision rules, specifying when to prompt users about keeping/deleting default tables, and reorganizing skill execution requirements. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@skills/lark-base/references/lark-base-base-create.md`:
- Line 70: 在文档中删除重复的“不在创建后立刻询问是否删除”的表述:保留该禁止规则仅在“禁止事项”(当前摘录处的行 89
所在段落,标识为禁止事项)并删除工作流步骤 5(标注为把默认表视为“默认保留”后紧跟的那句)和注意事项段落中重复的句子;在注意事项(当前行
103)改为一句简短的交叉引用,提示“关于创建后删除的禁止规则见禁止事项”,以避免重复并保持语义一致。
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8f68c9c5-9e4a-491a-bd1e-e6e3b864b10d
📒 Files selected for processing (1)
skills/lark-base/references/lark-base-base-create.md
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@4b904aa05c9c8f1cf4affb283a470ecb01a5a66b🧩 Skill updatenpx skills add kongenpei/lark-cli#fix-empty-base -y -g |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #459 +/- ##
=======================================
Coverage ? 60.19%
=======================================
Files ? 390
Lines ? 33433
Branches ? 0
=======================================
Hits ? 20125
Misses ? 11426
Partials ? 1882 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
🧹 Nitpick comments (1)
skills/lark-base/references/lark-base-base-create.md (1)
95-97: Simplified 注意事项 section - specific technical detail retained.The section is now streamlined to a single technical bullet point about not assuming table IDs, which complements the deletion prerequisites in line 91 without duplication. This specific implementation guidance is distinct from the general prohibition rules above.
💡 Optional: add cross-reference for easier navigation
If you want to make it even easier for readers to find the comprehensive deletion rules:
## 注意事项 +- 关于默认表删除的完整规则,参见上方"默认表删除决策规则"章节。 - 即使用户已同意删除,也不要直接假设默认表的 `table_id` 或名称;先列出表,再基于真实返回结果删除。However, given the PR's goal to simplify (not expand) the guidance, the current version is already clear without this addition.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/references/lark-base-base-create.md` around lines 95 - 97, The "注意事项" section was simplified down to a single technical bullet reminding readers not to assume a default table's `table_id` or name; update the "注意事项" under the heading "注意事项" to keep that single bullet exactly as shown (mentioning listing tables first and deleting based on actual returned results), ensure it does not duplicate the deletion prerequisites referenced near line 91, and do not add the optional cross-reference unless you want to expand guidance beyond the PR's simplification goal.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@skills/lark-base/references/lark-base-base-create.md`:
- Around line 95-97: The "注意事项" section was simplified down to a single
technical bullet reminding readers not to assume a default table's `table_id` or
name; update the "注意事项" under the heading "注意事项" to keep that single bullet
exactly as shown (mentioning listing tables first and deleting based on actual
returned results), ensure it does not duplicate the deletion prerequisites
referenced near line 91, and do not add the optional cross-reference unless you
want to expand guidance beyond the PR's simplification goal.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 219d8bad-b93c-45e7-a0ab-8d7e6f5742f6
📒 Files selected for processing (1)
skills/lark-base/references/lark-base-base-create.md
87b6a81 to
4b904aa
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
lark-base-empty-table-validation-cases.md (1)
40-45: Use per-session prompt files to avoid /tmp collisionsBoth cases write to fixed
/tmp/verify_prompt*.txtpaths. Parallel runs can overwrite each other. Prefer$TMP-scoped files.🧹 Suggested improvement
-cat >/tmp/verify_prompt1.txt <<'EOF' +cat >"$TMP/verify_prompt1.txt" <<'EOF' ... -acpx --timeout 240 --cwd "$TMP" --agent "coco acp serve -y" exec -f /tmp/verify_prompt1.txt +acpx --timeout 240 --cwd "$TMP" --agent "coco acp serve -y" exec -f "$TMP/verify_prompt1.txt"-cat >/tmp/verify_prompt2.txt <<'EOF' +cat >"$TMP/verify_prompt2.txt" <<'EOF' ... -acpx --timeout 240 --cwd "$TMP" --agent "coco acp serve -y" exec -f /tmp/verify_prompt2.txt +acpx --timeout 240 --cwd "$TMP" --agent "coco acp serve -y" exec -f "$TMP/verify_prompt2.txt"Also applies to: 68-73
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lark-base-empty-table-validation-cases.md` around lines 40 - 45, The test writes to fixed /tmp files (e.g. verify_prompt1.txt and pattern /tmp/verify_prompt*.txt) causing collisions in parallel runs; change the script to create per-session temp files under the test-scoped TMP directory (use "$TMP/verify_prompt1.txt" or mktemp within the same TMP scope) and update the acpx invocation that references /tmp/verify_prompt1.txt so it points to the session-scoped path; apply the same change for the other occurrences mentioned (lines 68-73) to ensure isolation.skills/lark-base/SKILL.md (1)
289-291: Align 4.3 trigger wording with rule 14 to avoid over-triggeringLine 289 says “继续操作了非默认表”, which is broader than rule 14’s trigger and may be read as including read-only actions. Recommend matching the exact trigger language used at Line 285.
✏️ Suggested wording adjustment
-只要当前会话里刚创建过 Base,且后续继续操作了非默认表,最终回复前都必须做这一步自检: +只要当前会话里刚创建过 Base,且后续新增了非默认表,或在非默认表里新增了字段、视图、记录,最终回复前都必须做这一步自检:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@skills/lark-base/SKILL.md` around lines 289 - 291, The trigger wording "继续操作了非默认表" is too broad and may include read-only actions; update the phrase to match rule 14's exact trigger language used earlier by replacing "继续操作了非默认表" with the precise wording "在非默认表里继续新增字段、视图、记录" in SKILL.md so the self-check only fires for creation/modification actions as intended.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@lark-base-empty-table-validation-cases.md`:
- Line 24: The setup step hardcodes a user-specific absolute path in the symlink
command (the line creating the symlink to
/Users/bytedance/.agents/skills/lark-shared), which breaks on other machines;
change that line to use a portable path (e.g., expand the user's home with $HOME
or derive the path relative to the repo root) so the symlink creation works for
any developer or CI environment, updating the single symlink command in
lark-base-empty-table-validation-cases.md accordingly.
---
Nitpick comments:
In `@lark-base-empty-table-validation-cases.md`:
- Around line 40-45: The test writes to fixed /tmp files (e.g.
verify_prompt1.txt and pattern /tmp/verify_prompt*.txt) causing collisions in
parallel runs; change the script to create per-session temp files under the
test-scoped TMP directory (use "$TMP/verify_prompt1.txt" or mktemp within the
same TMP scope) and update the acpx invocation that references
/tmp/verify_prompt1.txt so it points to the session-scoped path; apply the same
change for the other occurrences mentioned (lines 68-73) to ensure isolation.
In `@skills/lark-base/SKILL.md`:
- Around line 289-291: The trigger wording "继续操作了非默认表" is too broad and may
include read-only actions; update the phrase to match rule 14's exact trigger
language used earlier by replacing "继续操作了非默认表" with the precise wording
"在非默认表里继续新增字段、视图、记录" in SKILL.md so the self-check only fires for
creation/modification actions as intended.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 973c91b5-08f3-4a03-a7e4-808e7c740796
📒 Files selected for processing (4)
lark-base-empty-table-validation-cases.mdskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-base-create.mdskills/lark-base/references/lark-base-table-create.md
✅ Files skipped from review due to trivial changes (2)
- skills/lark-base/references/lark-base-table-create.md
- skills/lark-base/references/lark-base-base-create.md
Summary
Tighten the lark-base base-create guidance by removing duplicated wording in the default-table deletion notes.
Changes
Test Plan
Related Issues
Summary by CodeRabbit
Release Notes