docs: add concise AGENTS development guide#178
Conversation
📝 WalkthroughWalkthroughAdded Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Greptile SummaryThis PR adds a new
Confidence Score: 5/5Safe to merge — docs-only change with no runtime impact; all remaining findings are P2 quality suggestions. All findings are P2 style/completeness suggestions (missing govulncheck note, minor flag divergence between make unit-test and CI). Neither blocks correct CI behaviour nor introduces incorrect guidance that would cause a developer to miss a hard CI gate. The license-check concern from the previous review thread has been addressed by adding step 4 to the pre-PR checklist. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Start Dev Work] --> B[make build]
B --> C[Edit code]
C --> D[make unit-test]
D --> E{Tests pass?}
E -- No --> C
E -- Yes --> F[Run changed command manually
./lark-cli ...]
F --> G[Pre-PR Checks]
G --> G1[go mod tidy
check go.mod/go.sum unchanged]
G1 --> G2[golangci-lint
--new-from-rev=origin/main]
G2 --> G3{Dependencies
changed?}
G3 -- Yes --> G4[go-licenses check
./... --disallowed_types=...]
G3 -- No --> G5[govulncheck ⚠️
informational only]
G4 --> G5
G5 --> H[Draft PR from
.github/pull_request_template.md]
H --> I[Open PR]
Reviews (2): Last reviewed commit: "docs: remove toolchain prerequisite sect..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
AGENTS.md (1)
10-19: Add a Go toolchain prerequisite note near the dev loop/check commands.Given the reported local mismatch (
go1.25.8vsgo1.24.2), adding a one-line prerequisite (required Go version/source of truth) would prevent setup churn for contributors.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 10 - 19, Add a one-line Go toolchain prerequisite next to the "Fast Dev Loop" / "Pre-PR Checks" sections stating the required Go version (e.g., "Requires Go 1.25.8+") and where the source-of-truth is (e.g., the module 'go' directive in go.mod or CI/tooling matrix); update the AGENTS.md text near the listed commands so contributors see the required Go version upfront and a pointer to check go.mod or the CI config for the authoritative version.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@AGENTS.md`:
- Around line 10-19: Add a one-line Go toolchain prerequisite next to the "Fast
Dev Loop" / "Pre-PR Checks" sections stating the required Go version (e.g.,
"Requires Go 1.25.8+") and where the source-of-truth is (e.g., the module 'go'
directive in go.mod or CI/tooling matrix); update the AGENTS.md text near the
listed commands so contributors see the required Go version upfront and a
pointer to check go.mod or the CI config for the authoritative version.
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@f7537e6028a0eb21800c47719ab55037071cfe68🧩 Skill updatenpx skills add larksuite/cli#codex/agents-md-dev-guide -y -g |
|
Addressed review suggestions in latest commit (5da8133):\n- Added explicit Go toolchain prerequisite and source-of-truth note near dev/check workflow.\n- Added CI-aligned go-licenses check to pre-PR checks (when dependencies change). |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
AGENTS.md (1)
6-8: Consider varying sentence structure for readability.Three consecutive sentences begin with "Improve". While clear, varying the opening words can enhance readability.
✍️ Optional rewording suggestion
- Make CLI better: improve UX, error messages, help text, flags, and output clarity. -- Improve reliability: fix bugs, edge cases, and regressions with tests. -- Improve developer velocity: simplify code paths, reduce complexity, keep behavior explicit. -- Improve quality gates: strengthen tests/lint/checks without adding heavy process. +- Fix reliability issues: address bugs, edge cases, and regressions with tests. +- Boost developer velocity: simplify code paths, reduce complexity, keep behavior explicit. +- Strengthen quality gates: enhance tests/lint/checks without adding heavy process.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 6 - 8, Summary: the three consecutive bullets in AGENTS.md all start with "Improve", making the paragraph repetitive; change their openings to vary sentence structure. Locate the three bullets that begin with the phrases "Improve reliability:", "Improve developer velocity:", and "Improve quality gates:" and rewrite each opener to use different verbs or constructions (e.g., "Increase reliability:", "Boost developer velocity:", "Strengthen quality gates:" or similar alternatives) while keeping the existing explanatory text intact and preserving the colon/punctuation and intent. Ensure the revised bullets maintain parallel meaning and tone across the list.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@AGENTS.md`:
- Around line 6-8: Summary: the three consecutive bullets in AGENTS.md all start
with "Improve", making the paragraph repetitive; change their openings to vary
sentence structure. Locate the three bullets that begin with the phrases
"Improve reliability:", "Improve developer velocity:", and "Improve quality
gates:" and rewrite each opener to use different verbs or constructions (e.g.,
"Increase reliability:", "Boost developer velocity:", "Strengthen quality
gates:" or similar alternatives) while keeping the existing explanatory text
intact and preserving the colon/punctuation and intent. Ensure the revised
bullets maintain parallel meaning and tone across the list.
* docs: add concise AGENTS development guide * docs: align AGENTS with toolchain and CI license checks * docs: remove toolchain prerequisite section --------- Co-authored-by: kongenpei <kongenpei@users.noreply.github.com>
2 participants
Summary
Add a concise
AGENTS.mdwith explicit repo development guidance focused on local build/test/check flow and PR hygiene.Changes
AGENTS.mdat repo root with:.github/pull_request_template.mdbefore opening a real PRgo-licensespre-PR check when dependencies changeTest Plan
lark xxxcommand works as expectedNotes:
make unit-teston commitf7537e6.shortcuts/mailonly:TestConfirmSendMissingScopeReplyTestConfirmSendMissingScopeReplyAllTestConfirmSendMissingScopeForwardSetStoredToken() error = exit status 154.AGENTS.md) and does not change runtime behavior.Related Issues
Summary by CodeRabbit