Skip to content

docs: clarify that lark-drive comment listing defaults to unresolved comments only#609

Merged
fangshuyu-768 merged 1 commit intomainfrom
docs/lark-drive-unresolved-comments-default
Apr 22, 2026
Merged

docs: clarify that lark-drive comment listing defaults to unresolved comments only#609
fangshuyu-768 merged 1 commit intomainfrom
docs/lark-drive-unresolved-comments-default

Conversation

@wittam-01
Copy link
Copy Markdown
Collaborator

@wittam-01 wittam-01 commented Apr 22, 2026

Change-Id: Ie4200fe14f1e3c4735c1fcc4aba4a3f9a4900e22

Summary

Clarifies that drive file.comments list defaults to unresolved comments only, and that callers must pass is_solved:false unless the user explicitly asks to include resolved comments. This reduces agent ambiguity and makes the intended default behavior easier to follow at execution time.

Changes

  • Added an explicit mandatory rule in skills/lark-drive/SKILL.md that drive file.comments list should default to unresolved comments only
  • Added correct/incorrect examples for is_solved:false usage and mirrored the rule next to the file.comments list command entry

Test Plan

  • Unit tests pass
  • Manual local verification confirms the lark xxx command works as expected
  • Docs-only change; no code or command behavior was modified

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified comment-listing behavior: the comment query now defaults to showing unresolved comments unless users explicitly request solved ones.
    • Added explicit “correct” and “incorrect” usage examples to guide query parameter inclusion.
    • Clarified the upload shortcut description to specify uploading a local file to a Drive folder or to a wiki node.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4e8719de-3bdb-4627-92e4-ae2f3723051d

📥 Commits

Reviewing files that changed from the base of the PR and between 999a1e3 and 0358c05.

📒 Files selected for processing (2)
  • skill-template/domains/drive.md
  • skills/lark-drive/SKILL.md
✅ Files skipped from review due to trivial changes (2)
  • skills/lark-drive/SKILL.md
  • skill-template/domains/drive.md

📝 Walkthrough

Walkthrough

Documentation updates for Lark Drive: enforce is_solved:false as the default query parameter for drive file.comments list and add explicit correct/incorrect examples; clarify +upload shortcut wording to specify uploading local files to Drive folders or wiki nodes.

Changes

Cohort / File(s) Summary
Drive Comment Query Rules
skill-template/domains/drive.md, skills/lark-drive/SKILL.md
Added rule requiring is_solved:false by default when calling drive file.comments list; included explicit "correct" and "error" example commands to show when is_solved must be provided or may be omitted.
Wiki Upload Guidance
skills/lark-drive/SKILL.md
Adjusted +upload shortcut description to specify uploading a local file to a Drive folder or a wiki node; clarified use of lark-cli drive +upload --wiki-token for wiki uploads.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested labels

domain/ccm

Suggested reviewers

  • fangshuyu-768

Poem

🐰 I nibbled through the docs today, so spry and light,
Now comments ask for is_solved:false by default—just right.
Uploads hop to folders or wiki nodes with glee,
Clear examples guide the path for you and me,
A happy little rabbit dances in the README’s light.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: clarifying the default behavior of lark-drive comment listing to unresolved comments only.
Description check ✅ Passed The description covers all required template sections (Summary, Changes, Test Plan, Related Issues) with sufficient detail about the documentation updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/lark-drive-unresolved-comments-default

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.

@github-actions github-actions Bot added the size/M Single-domain feat or fix with limited business impact label Apr 22, 2026
…comments only

Change-Id: Ie4200fe14f1e3c4735c1fcc4aba4a3f9a4900e22
@wittam-01 wittam-01 force-pushed the docs/lark-drive-unresolved-comments-default branch from 999a1e3 to 0358c05 Compare April 22, 2026 09:24
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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@skill-template/domains/drive.md`:
- Around line 131-133: The example title "查询所有评论" conflicts with the command
filter because the params include "is_solved": false (unresolved-only); update
the label to reflect unresolved comments or remove/adjust the is_solved
parameter so it actually queries all comments—locate the example in
skill-template/domains/drive.md and change the heading or the JSON param (the
is_solved field in the lark-cli drive file.comments list example) so the title
and the command semantics match.

In `@skills/lark-drive/SKILL.md`:
- Around line 144-146: Heading "查询所有评论(用户未明确要求包含已解决评论)" is inaccurate because
the example command includes "is_solved": false (unresolved-only); update the
label to reflect unresolved comments, e.g., change that heading to "查询未解决的评论" or
remove the is_solved filter from the command if you truly want "all comments";
target the heading text in SKILL.md and/or the example command to keep them
consistent.
🪄 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: 86dfaa7a-5e65-420a-86b2-40f57821cfa0

📥 Commits

Reviewing files that changed from the base of the PR and between 0192cee and 999a1e3.

📒 Files selected for processing (2)
  • skill-template/domains/drive.md
  • skills/lark-drive/SKILL.md

Comment thread skill-template/domains/drive.md
Comment thread skills/lark-drive/SKILL.md
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 22, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@0358c05834674f42a9ae5942ff7f9a8c0759c2ba

🧩 Skill update

npx skills add larksuite/cli#docs/lark-drive-unresolved-comments-default -y -g

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 59.94%. Comparing base (c13644a) to head (0358c05).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #609      +/-   ##
==========================================
- Coverage   61.69%   59.94%   -1.76%     
==========================================
  Files         402      405       +3     
  Lines       35073    42673    +7600     
==========================================
+ Hits        21639    25580    +3941     
- Misses      11429    15084    +3655     
- Partials     2005     2009       +4     

☔ 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.

@fangshuyu-768 fangshuyu-768 merged commit 543a836 into main Apr 22, 2026
22 checks passed
@fangshuyu-768 fangshuyu-768 deleted the docs/lark-drive-unresolved-comments-default branch April 22, 2026 09:37
@coderabbitai coderabbitai Bot mentioned this pull request Apr 22, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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