Skip to content

docs: clarify contributor guidance#1096

Merged
liangshuo-1 merged 1 commit into
mainfrom
docs/contributor-guidance
May 26, 2026
Merged

docs: clarify contributor guidance#1096
liangshuo-1 merged 1 commit into
mainfrom
docs/contributor-guidance

Conversation

@liangshuo-1

@liangshuo-1 liangshuo-1 commented May 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

Cherry-picked from #983 (authored by @JulyanXu) to land the documentation clarifications on top of latest main. Many thanks to @JulyanXu for the original contribution — original commit attribution is preserved.

Changes

  • Link the English and Chinese Contributing sections to AGENTS.md, where the repository already keeps the local build, test, and PR checklist.
  • Update the PR template manual verification checklist item from the old lark xxx placeholder to the actual lark-cli <domain> <command> form.

Test Plan

  • git diff --check
  • make fmt-check
  • node scripts/skill-format-check/index.js
  • Unit tests — not run; docs/template-only change
  • Manual local verification — not applicable; no CLI behavior change

Related

Summary by CodeRabbit

  • Documentation
    • Updated contribution guidance with clearer instructions for preparing pull requests.
    • Revised the pull-request checklist to reference the current CLI flow.
    • Added contributor notes directing readers to the project’s local build, test, and PR checklist documentation (available in English and Chinese).

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 26, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 84450f24-0392-43e2-bccb-0f6ef6d4ac96

📥 Commits

Reviewing files that changed from the base of the PR and between d174a89 and 960a2ff.

📒 Files selected for processing (3)
  • .github/pull_request_template.md
  • README.md
  • README.zh.md
✅ Files skipped from review due to trivial changes (1)
  • .github/pull_request_template.md

📝 Walkthrough

Walkthrough

This PR updates contributor documentation: the PR template checklist now references lark-cli <domain> <command>, and English and Chinese READMEs add a "Before opening a PR" note pointing contributors to AGENTS.md for local build, test, and PR guidance.

Changes

Contributor Documentation and PR Process

Layer / File(s) Summary
PR template command verification update
.github/pull_request_template.md
PR template checklist item updated to reference lark-cli <domain> <command> workflow instead of legacy lark xxx command.
Contributor documentation updates
README.md, README.zh.md
Both English and Chinese README files add "Before opening a PR" guidance directing contributors to AGENTS.md for local build, test, and PR verification checklists.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • larksuite/cli#176: Updates the PR template checklist item to use the lark-cli <domain> <command> flow and references the new CLI workflow.
  • larksuite/cli#178: Introduces AGENTS.md and aligns PR template updates with the new lark-cli command workflow.

Suggested labels

documentation, size/S

Suggested reviewers

  • kongenpei

Poem

🐰 A tiny hop, a checklist bright,
📋 The CLI sings through day and night,
📖 AGENTS.md lights the contributor way,
✨ PRs now follow a clearer day,
🥕 Cheers from a rabbit — build and play!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: clarify contributor guidance' accurately reflects the main changes in the PR, which focus on updating documentation and the PR template to provide clearer contributor guidance.
Description check ✅ Passed The description follows the required template structure with Summary, Changes, Test Plan, and Related Issues sections, all substantially completed with relevant details.
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/contributor-guidance

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/S Low-risk docs, CI, test, or chore only changes label May 26, 2026
@codecov

codecov Bot commented May 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.92%. Comparing base (ee9d090) to head (960a2ff).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1096   +/-   ##
=======================================
  Coverage   67.92%   67.92%           
=======================================
  Files         601      601           
  Lines       55766    55766           
=======================================
  Hits        37880    37880           
  Misses      14751    14751           
  Partials     3135     3135           

☔ 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

github-actions Bot commented May 26, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#docs/contributor-guidance -y -g

(cherry picked from commit 406e0de)
@liangshuo-1
liangshuo-1 force-pushed the docs/contributor-guidance branch from d174a89 to 960a2ff Compare May 26, 2026 05:09
@liangshuo-1
liangshuo-1 merged commit 83adbac into main May 26, 2026
21 checks passed
@liangshuo-1
liangshuo-1 deleted the docs/contributor-guidance branch May 26, 2026 07:51
tuxedomm pushed a commit to zhumiaoxin/cli that referenced this pull request Jun 6, 2026
(cherry picked from commit 406e0de)

Co-authored-by: JulyanXu <1581085037@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Low-risk docs, CI, test, or chore only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants