fix: add expression to avoid misunderstanding

[syh-cpdsss]

Summary by CodeRabbit

• Documentation
  • Added a new reference section mapping common user expressions (e.g., progress/completion, updates/check‑ins, objective/key-result status, scoring, and alignment) to their corresponding OKR concepts and fields to improve clarity when interpreting and entering OKR data.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a98882dc-99e2-45f7-b443-5785e5b48dd8

📥 Commits

Reviewing files that changed from the base of the PR and between 4a1960d and b709824.

📒 Files selected for processing (1)

• skills/lark-okr/references/lark-okr-entities.md

✅ Files skipped from review due to trivial changes (1)

• skills/lark-okr/references/lark-okr-entities.md

---

📝 Walkthrough

Walkthrough

Documentation enhancement adding a "常用用户表述" ("Common User Expressions") section that maps natural language user terms (progress, updates, status, scores, alignment) to specific OKR entities and fields.

Changes

OKR Entity Documentation

Layer / File(s)	Summary
Common user expression mappings skills/lark-okr/references/lark-okr-entities.md	New section maps natural language user expressions (进度/完成度 → Indicator.current_value; 进展/更新/Check-in → Progress; Objective/KeyResult 状态 → Indicator.indicator_status with distinction from ProgressRate; 打分/评分 → Objective.score/KeyResult.score/Cycle.score; 对齐/挂靠 → Alignment).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

• zhangzq0

Poem

A rabbit hops through OKR fields,
Mapping words to entities that yield,
Progress, scores, and alignments clear,
Users find the meanings near,
Docs bloom soft — a guiding trail. 🐇📚

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The pull request description is completely empty, missing all required sections from the template including Summary, Changes, Test Plan, and Related Issues.	Add a complete pull request description following the repository template, including a summary of the documentation changes, list of changes, and how the changes were verified.
Title check	❓ Inconclusive	The title is vague and doesn't clearly describe the main change, which is adding user expression mappings to OKR entity documentation.	Revise the title to be more specific, such as 'docs: add common user expressions to OKR entities mapping' to clearly convey the documentation addition.

✅ Passed checks (3 passed)

Check name	Status	Explanation
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 fix/okr_skill

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

skills/lark-okr/references/lark-okr-entities.md (1)

28-30: ⚡ Quick win

“状态”表述建议区分为两类，避免歧义。

Line 28-30 将“Objective 或 KeyResult 的状态”直接映射到 Indicator.indicator_status，容易和 ProgressRate.status（normal/overdue/done）混淆。建议补一条状态词汇区分规则。

建议补充示例

 - "Objective 或 KeyResult 的状态"
   - 对应字段: Indicator.indicator_status
+- "进展状态 / 是否逾期 / 是否已完成"
+  - 对应字段: Progress.progress_rate.status

🤖 Prompt for 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.

In `@skills/lark-okr/references/lark-okr-entities.md` around lines 28 - 30, The
doc currently maps "Objective 或 KeyResult 的状态" to Indicator.indicator_status but
this conflicts with ProgressRate.status (normal/overdue/done); update the
documentation to add a clear distinction rule: state that
Indicator.indicator_status represents lifecycle/semantic state of the indicator
(e.g., active, archived, cancelled) while ProgressRate.status represents
progress timeline states (normal, overdue, done), and add a short example
showing each field usage (e.g., Indicator.indicator_status = "active",
ProgressRate.status = "overdue"); reference the symbols
Indicator.indicator_status and ProgressRate.status in the text so readers can
see the separation.

🤖 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-okr/references/lark-okr-entities.md`:
- Around line 24-27: The mapping for “进度/完成度” is too narrow—update the doc to
distinguish when to use Indicator.current_value versus
Progress.progress_rate.percent: indicate Indicator.current_value is for
quantitative metric current values (e.g., KPI raw numbers or counts) while
Progress.progress_rate.percent is for textual check-ins or updates that express
completion as a percentage; adjust the lines referencing Indicator and Progress
to state these contexts explicitly so parsers/annotators pick the correct field.

---

Nitpick comments:
In `@skills/lark-okr/references/lark-okr-entities.md`:
- Around line 28-30: The doc currently maps "Objective 或 KeyResult 的状态" to
Indicator.indicator_status but this conflicts with ProgressRate.status
(normal/overdue/done); update the documentation to add a clear distinction rule:
state that Indicator.indicator_status represents lifecycle/semantic state of the
indicator (e.g., active, archived, cancelled) while ProgressRate.status
represents progress timeline states (normal, overdue, done), and add a short
example showing each field usage (e.g., Indicator.indicator_status = "active",
ProgressRate.status = "overdue"); reference the symbols
Indicator.indicator_status and ProgressRate.status in the text so readers can
see the separation.

🪄 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: 527cff77-e864-46d3-ad2a-591791a128a0

📥 Commits

Reviewing files that changed from the base of the PR and between 4a45e00 and 4a1960d.

📒 Files selected for processing (1)

• skills/lark-okr/references/lark-okr-entities.md

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.95%. Comparing base (f03138b) to head (b709824).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #903   +/-   ##
=======================================
  Coverage   65.95%   65.95%           
=======================================
  Files         523      523           
  Lines       49590    49590           
=======================================
  Hits        32707    32707           
  Misses      14090    14090           
  Partials     2793     2793           

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

[github-actions]

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#fix/okr_skill -y -g