docs: prefer local comments for drive reviews#981
Conversation
📝 WalkthroughWalkthroughUpdates Lark Drive docs to require preferring local (block/cell/slide-element) comments for review scenarios, adding a “Review 场景评论落点” guideline and expanding ChangesReview Scenario Comment Placement Guidance
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-drive/references/lark-drive-add-comment.md`:
- Line 160: The Behavior section "Review 场景优先局部评论" mandates local
block/cell/slide comments but the `--block-id` mode description only lists
`docx` and `slides`; update the `--block-id` mode documentation to also include
`sheet` (e.g., add `sheet` to the supported modes for `--block-id`) and adjust
any examples or mode lists in the same section so they consistently reflect that
`sheet` is supported for block-local comments.
In `@skills/lark-drive/SKILL.md`:
- Around line 143-145: The SKILL.md section that currently states local comments
are supported only for `docx` (or wiki→`docx`) conflicts with the new rule
requiring local comments for `docx/sheet/slides`; update the capability
statement to explicitly include `sheet` and `slides` alongside `docx` (and
remove or revise the wiki→docx special-case) so the guidance is consistent; make
the same change in the other occurrence covering the same paragraph (the block
that lists the three bullet points about using `--block-id` and per-issue local
comments) to keep both mentions aligned.
🪄 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: d65b48b3-47a6-4e29-a2f0-f3512cac8d3a
📒 Files selected for processing (2)
skills/lark-drive/SKILL.mdskills/lark-drive/references/lark-drive-add-comment.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #981 +/- ##
==========================================
+ Coverage 67.41% 67.58% +0.17%
==========================================
Files 572 575 +3
Lines 53697 54269 +572
==========================================
+ Hits 36200 36679 +479
- Misses 14489 14548 +59
- Partials 3008 3042 +34 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@89bc5abedee9e93421863e67252bceb75353f984🧩 Skill updatenpx skills add larksuite/cli#docs/drive-comment-local-review-guidance -y -g |
Change-Id: Ie2eaa54320cd2612b66b2d617750d23b950e38db
68fb0bf to
8a254d3
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-drive/SKILL.md`:
- Around line 189-190: Update the fallback rule sentence in SKILL.md (the line
that currently allows falling back to 全文评论 when “无法稳定定位”) to require the target
supports full-document comments by adding the clause “且目标类型支持全文评论”; specifically
change the sentence that begins with
“只有在用户明确要求全文/总体评论、评论内容确实是文档级总结、目标类型不支持局部评论,或无法稳定定位到具体位置时,才退回全文评论” to include
“且目标类型支持全文评论” so the fallback is gated, and ensure the nearby reference to
`drive +add-comment` behavior remains accurate.
🪄 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: fc67c0d7-a3f4-4fd3-8198-873427448a62
📒 Files selected for processing (2)
skills/lark-drive/SKILL.mdskills/lark-drive/references/lark-drive-add-comment.md
✅ Files skipped from review due to trivial changes (1)
- skills/lark-drive/references/lark-drive-add-comment.md
Change-Id: Ia7512babe3656b57374c86068198c8192871ff81
Summary
Clarify lark-drive skill guidance for review and document-audit scenarios. The updated guidance steers agents to prefer localized comments whenever a concrete document position can be identified, instead of collecting all findings into a single full-document comment.
Changes
Test Plan
Related Issues
Summary by CodeRabbit