Skip to content

docs: simplify lark base create guidance#459

Closed
kongenpei wants to merge 5 commits intolarksuite:mainfrom
kongenpei:fix-empty-base
Closed

docs: simplify lark base create guidance#459
kongenpei wants to merge 5 commits intolarksuite:mainfrom
kongenpei:fix-empty-base

Conversation

@kongenpei
Copy link
Copy Markdown
Collaborator

@kongenpei kongenpei commented Apr 13, 2026

Summary

Tighten the lark-base base-create guidance by removing duplicated wording in the default-table deletion notes.

Changes

  • simplify the 注意事项 section for default empty table handling
  • keep the deletion-safety rules explicit and unchanged in intent

Test Plan

  • Unit tests pass
  • Manual local verification confirms the documentation wording is concise and consistent

Related Issues

  • None

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated Base creation guidance to clarify that newly created Bases include one default empty table
    • Enhanced prompts when adding non-default tables to newly created Bases, requesting clarification on default table retention
    • Strengthened safeguards requiring explicit confirmation and table verification before allowing default table deletion

@kongenpei kongenpei requested a review from zgz2048 April 13, 2026 16:26
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kongenpei has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels Apr 13, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 13, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b73eb78d-4494-43e0-a2f2-1558b86ebeff

📥 Commits

Reviewing files that changed from the base of the PR and between 87b6a81 and 4b904aa.

📒 Files selected for processing (3)
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-base-create.md
  • skills/lark-base/references/lark-base-table-create.md
✅ Files skipped from review due to trivial changes (1)
  • skills/lark-base/references/lark-base-base-create.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-table-create.md

📝 Walkthrough

Walkthrough

The 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

Cohort / File(s) Summary
Base Creation Guidance
skills/lark-base/references/lark-base-base-create.md
Added response requirements after successful Base creation, including clarification that new Base includes 1 default empty table with 5–10 empty records. Introduced "Default Table Deletion Decision Rules" section detailing when deletion prompts should trigger, recommended phrasing, and prohibited actions (e.g., no immediate deletion questions post-creation).
Skill Execution Rules
skills/lark-base/SKILL.md
Added Rule 14 requiring a standalone clarification sentence about default table retention when non-default tables are added. Replaced section "4.3 并发、分页与批量限制" with "4.3 新建 Base 收尾检查" (New Base Finalization Check) defining required self-check flow. Renumbered subsequent "确认与回复规则" section from 4.4 to 4.5.
Table Creation Documentation
skills/lark-base/references/lark-base-table-create.md
Added [!IMPORTANT] notice clarifying interaction requirements when a non-default table is created in a newly-created Base, requiring proactive clarification about retaining the default empty table with suggested follow-up question examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • zhouyue-bytedance
  • zgz2048

Poem

🐰 A Base is born, so fresh and new,
With empty table shining through,
"Keep it or delete?" we softly ask,
After tables grow—that's the task!
Default rules now crystal clear,
Hops of joy for users here! 🎉

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: simplify lark base create guidance' is vague and generic, using the broad term 'simplify' without specifying which aspect is being simplified. Replace with a more specific title that clarifies the main change, e.g., 'docs: clarify default table deletion rules for base creation' or 'docs: tighten default-table guidance for base-create'.
Description check ❓ Inconclusive The PR description covers Summary and Changes sections, but the Test Plan lacks sufficient detail and unit tests remain pending, making verification incomplete. Complete unit test verification and provide more detail on what was manually tested, e.g., which documentation sections or scenarios were validated for accuracy.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2910cde and 9283ead.

📒 Files selected for processing (1)
  • skills/lark-base/references/lark-base-base-create.md

Comment thread skills/lark-base/references/lark-base-base-create.md Outdated
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 13, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@4b904aa05c9c8f1cf4affb283a470ecb01a5a66b

🧩 Skill update

npx skills add kongenpei/lark-cli#fix-empty-base -y -g

zgz2048
zgz2048 previously approved these changes Apr 14, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (main@815db0c). Learn more about missing BASE report.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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

📥 Commits

Reviewing files that changed from the base of the PR and between b4cee9e and cdba867.

📒 Files selected for processing (1)
  • skills/lark-base/references/lark-base-base-create.md

zgz2048
zgz2048 previously approved these changes Apr 20, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 collisions

Both cases write to fixed /tmp/verify_prompt*.txt paths. 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-triggering

Line 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

📥 Commits

Reviewing files that changed from the base of the PR and between cdba867 and 87b6a81.

📒 Files selected for processing (4)
  • lark-base-empty-table-validation-cases.md
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-base-create.md
  • skills/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

Comment thread lark-base-empty-table-validation-cases.md Outdated
@kongenpei kongenpei closed this Apr 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants