Skip to content

docs: clarify contributor guidance#983

Open
JulyanXu wants to merge 1 commit into
larksuite:mainfrom
JulyanXu:codex/contributor-guidance
Open

docs: clarify contributor guidance#983
JulyanXu wants to merge 1 commit into
larksuite:mainfrom
JulyanXu:codex/contributor-guidance

Conversation

@JulyanXu
Copy link
Copy Markdown

@JulyanXu JulyanXu commented May 20, 2026

Summary

Clarify contributor-facing guidance by linking the README contribution sections to AGENTS.md, where the repository already keeps the local build, test, and PR checklist. Also update the PR template example command from the old lark xxx placeholder to the actual lark-cli <domain> <command> form.

Changes

  • Link the English and Chinese Contributing sections to AGENTS.md
  • Update the PR template manual verification checklist item to use lark-cli <domain> <command>

Test Plan

  • git diff --check
  • make fmt-check
  • node scripts/skill-format-check/index.js
  • Unit tests pass — not run; docs/template-only change
  • Manual local verification confirms the lark-cli <domain> <command> flow works as expected — not applicable; no CLI behavior change

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Updated the pull request template to reflect the current command-line workflow syntax and contribution checklist.
    • Added a pre‑PR notice in English and Chinese README content directing contributors to consult the supplementary local build, test, and pre-submission checklist documentation.

Review Change Stack

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 20, 2026

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 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: 483b5dcc-bb1f-4a3e-b1cd-4b27666312d1

📥 Commits

Reviewing files that changed from the base of the PR and between 6a4587e and 406e0de.

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

📝 Walkthrough

Walkthrough

Three documentation files updated: the PR template's manual verification checklist now references lark-cli <domain> <command>, and both English and Chinese READMEs add notices directing contributors to AGENTS.md for build, test, and PR checklist details.

Changes

Contributor Documentation and Workflow Updates

Layer / File(s) Summary
PR template workflow reference
.github/pull_request_template.md
Manual verification checklist updated from lark xxx to lark-cli <domain> <command> command syntax.
Contributor guidance in README files
README.md, README.zh.md
English and Chinese README files add pre-PR notices directing contributors to AGENTS.md for local build, test, and PR checklist guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • larksuite/cli#176: Updates the pull request template's manual checklist wording related to the lark-cli <domain> <command> workflow.
  • larksuite/cli#178: Introduces AGENTS.md and aligns README/PR-template guidance with the lark-cli workflow.

Suggested reviewers

  • liangshuo-1
  • hugang-lark

Poem

🐰 I nibble docs with gentle cheer,
New lines for contributors near.
lark-cli steps now hop in place,
AGENTS.md guides the quiet pace.
Hooray—PRs land with tidy grace!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: clarify contributor guidance' clearly and accurately summarizes the main change—improving contributor documentation by clarifying guidance links.
Description check ✅ Passed The PR description includes all required sections: Summary, Changes, Test Plan, and Related Issues, with sufficient detail explaining the motivation and scope of changes.
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

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 20, 2026
@JulyanXu
Copy link
Copy Markdown
Author

JulyanXu commented May 20, 2026 via email

@JulyanXu JulyanXu force-pushed the codex/contributor-guidance branch from 6a4587e to 406e0de Compare May 20, 2026 06:41
@codecov
Copy link
Copy Markdown

codecov Bot commented May 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.59%. Comparing base (27a5eed) to head (406e0de).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #983      +/-   ##
==========================================
+ Coverage   67.58%   67.59%   +0.01%     
==========================================
  Files         575      575              
  Lines       54269    54269              
==========================================
+ Hits        36679    36685       +6     
+ Misses      14548    14543       -5     
+ Partials     3042     3041       -1     

☔ 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
Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add JulyanXu/cli#codex/contributor-guidance -y -g

@sang-neo03
Copy link
Copy Markdown
Collaborator

Hi @JulyanXu — the lint failure isn't from your changes. It's pointing at shortcuts/sheets/lark_sheets_cell_images.go:14 (depguard shortcuts-no-vfs), which this PR doesn't touch.

Root cause: your branch is 13 commits behind main. The vfs import on that line was already removed on main by #996 (fix(sheets): use FileIO for write-image input), but it still
exists on your branch. CI runs golangci-lint --new-from-rev=origin/main, so the stale line shows up as "newly introduced" against the current main.

Quick fix — no PR content change needed, just sync the branch:

gh pr checkout 983
git fetch origin main
git merge origin/main # or: git rebase origin/main
git push

Once the merge lands, lark_sheets_cell_images.go picks up the main-side fix and lint will pass. The PR itself looks good to me — happy to approve after CI is green.

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.

3 participants