docs(base): clarify complete and partial updates - #1993
Conversation
Consolidate the update rule introduced in larksuite#1879 and make the command-contract boundary explicit. Full-update commands must use trusted current configuration for the first actual request, while delta commands should send the smallest legal payload.
|
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 (1)
📝 WalkthroughWalkthrough更新 ChangesLark Base update guidance
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
@coderabbitai review |
✅ Action performedReview finished.
|
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-base/SKILL.md`:
- Line 32: 更新该 SKILL.md 中关于完整配置更新的说明:对于要求完整配置的更新(尤其是 PUT
风格字段更新),必须保留当前配置中的全部可写属性,仅修改用户明确指定的字段;首次请求应基于可信的当前配置执行
read-modify-write,并继续遵循命令要求的 payload 结构。
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Address review feedback by requiring unchanged writable configuration to remain intact, except when the requested update makes a setting inapplicable.
47b4e30 to
215c199
Compare
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@9fcd6218b2c7de67fae88c075d10c24e62d2ac2a🧩 Skill updatenpx skills add huarenmin13/cli#agent/base-update-contract-boundary -y -g |
* docs(base): clarify complete and partial updates Consolidate the update rule introduced in #1879 and make the command-contract boundary explicit. Full-update commands must use trusted current configuration for the first actual request, while delta commands should send the smallest legal payload. * docs(base): clarify full-update state preservation Address review feedback by requiring unchanged writable configuration to remain intact, except when the requested update makes a setting inapplicable. * docs(base): strengthen update contract guidance
Summary
Clarify the command-contract boundary for Base updates. This is a focused follow-up to #1879: full-update commands must start from trusted current configuration, while true partial/delta commands should use the smallest legal payload.
Changes
Test Plan
node scripts/skill-format-check/index.jsgo test ./internal/qualitygate/skillscan/...make unit-testgo vet ./...gofmt -l .(no output)go mod tidy(no changes)go run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@v2.1.6 run --new-from-rev=origin/main(0 issues)git diff --checkRelated Issues
Summary by CodeRabbit
--help/参考文档。