Skip to content

docs: require word count validation for doc creation#1760

Closed
fangshuyu-768 wants to merge 1 commit into
mainfrom
docs-skill-require-word-count-check
Closed

docs: require word count validation for doc creation#1760
fangshuyu-768 wants to merge 1 commit into
mainfrom
docs-skill-require-word-count-check

Conversation

@fangshuyu-768

@fangshuyu-768 fangshuyu-768 commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • make word-count validation a required gate when doc creation requests include explicit length constraints
  • delegate the concrete validation procedure to lark-doc-word-stat.md instead of repeating it in the create workflow
  • require final reporting of the target range, word_count, and pass/fail result when validation runs

Testing

  • Not run; documentation-only change.

Summary by CodeRabbit

  • Documentation
    • Updated the workflow to treat “专项校验” as a standard step only when users provide an explicit word-count requirement (e.g., a specific range or upper/lower limits).
    • If no clear word-count requirement is given, the check is now skipped.
    • When run, the documentation clarifies that results are only shown after word-count evaluation, including the target range, the computed word count, and a clear pass/fail conclusion.

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updates the workflow documentation for “专项校验” so word-count validation runs only when explicit word-count requirements are provided, uses the script’s word_count result, and withholds any compliance claim until that result is available.

Changes

Workflow documentation update

Layer / File(s) Summary
Word-count validation rule update
skills/lark-doc/references/style/lark-doc-create-workflow.md
Step four now requires validation only when the user states explicit word-count constraints, skips it otherwise, and requires presenting the target range, word_count, and pass/fail result after script output is obtained.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • larksuite/cli#1463: Also adjusts validation-related wording in skills/lark-doc/references/style/lark-doc-create-workflow.md.

Suggested reviewers: SunPeiYang996, caojie0621

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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.
Title check ✅ Passed The title clearly matches the main change: requiring word-count validation for document creation.
Description check ✅ Passed The description captures the scope and testing status, but it does not follow the template headings for Changes and Related Issues.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-skill-require-word-count-check

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.

@github-actions github-actions Bot added domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jul 6, 2026
@fangshuyu-768
fangshuyu-768 force-pushed the docs-skill-require-word-count-check branch from 295a6e1 to 85a39e9 Compare July 6, 2026 06:39
@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#docs-skill-require-word-count-check -y -g

@fangshuyu-768

Copy link
Copy Markdown
Collaborator Author

Superseded by #1759, which now includes this word-count validation change together with the duplicate-title guidance.

@codecov

codecov Bot commented Jul 6, 2026

Copy link
Copy Markdown

Codecov Report

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1760   +/-   ##
=======================================
  Coverage   74.42%   74.42%           
=======================================
  Files         854      854           
  Lines       88477    88477           
=======================================
  Hits        65852    65852           
  Misses      17555    17555           
  Partials     5070     5070           

☔ View full report in Codecov by Harness.
📢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/ccm PR touches the ccm 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.

1 participant