Skip to content

docs: update CLAUDE.md to instruct AI to run install.sh and TestFromTestdata locally#639

Merged
luoliwoshang merged 4 commits into
mainfrom
xgopilot/issue-638-1770809654
Feb 11, 2026
Merged

docs: update CLAUDE.md to instruct AI to run install.sh and TestFromTestdata locally#639
luoliwoshang merged 4 commits into
mainfrom
xgopilot/issue-638-1770809654

Conversation

@fennoai
Copy link
Copy Markdown
Contributor

@fennoai fennoai Bot commented Feb 11, 2026

Requested by @luoliwoshang

Closes #638

Summary

  • Added a new "After Modifying LLGo-Compiled Components" section to CLAUDE.md
  • Instructs AI assistants to run bash ./install.sh to rebuild LLGo-compiled tools before testing
  • Instructs AI assistants to run go test -v ./cl/internal/convert -run TestFromTestdata to verify changes locally
  • Clarifies that tests should NOT be marked as "requires CI" since they can be run locally after install.sh
  • Includes guidance on using gen:true to regenerate expected output when test output changes are expected

Test plan

  • Verify CLAUDE.md renders correctly with the new section
  • Confirm the new section is placed logically within the "Building and Testing" area

…estdata locally

Add a new "After Modifying LLGo-Compiled Components" section that explicitly
instructs AI assistants to run `bash ./install.sh` and then verify changes with
`go test -v ./cl/internal/convert -run TestFromTestdata` instead of deferring
to CI.

Closes #638

Generated with [codeagent](https://github.com/qbox/codeagent)
Co-authored-by: luoliwoshang <51194195+luoliwoshang@users.noreply.github.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 11, 2026

Codecov Report

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #639   +/-   ##
=======================================
  Coverage   84.74%   84.74%           
=======================================
  Files          27       27           
  Lines        2314     2314           
=======================================
  Hits         1961     1961           
  Misses        310      310           
  Partials       43       43           

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

Comment thread CLAUDE.md
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xgopilot only need tell the components need install , and the test like TestFromTestdata depend these component,so change the components ( or it's depend) we need reinstall these!

Copy link
Copy Markdown
Contributor Author

@fennoai fennoai Bot Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the "After Modifying LLGo-Compiled Components" section in CLAUDE.md to:

  • Explicitly list the LLGo-compiled components that need install.sh (llcppsigfetch, llcppsymg)
  • Note their shared internal packages under _xtool/internal/
  • Explain that TestFromTestdata invokes llcppsigfetch as a subprocess, so it depends on the installed binary being up to date
  • Clarify that modifying any code under _xtool/ (including its internal dependencies) requires reinstallation

Pushed in commit 0be7d62.

…n TestFromTestdata

Expanded the "After Modifying LLGo-Compiled Components" section to explicitly
list the LLGo-compiled tools (llcppsigfetch, llcppsymg), explain their shared
internal packages, and describe how TestFromTestdata depends on these installed
binaries — so modifying any _xtool/ code requires reinstallation.

Generated with [codeagent](https://github.com/qbox/codeagent)
Co-authored-by: luoliwoshang <51194195+luoliwoshang@users.noreply.github.com>
Comment thread CLAUDE.md Outdated
Comment on lines +87 to +92
**When you modify any code under `_xtool/` (including its internal dependencies), you MUST:**

1. **Run `bash ./install.sh`** to rebuild and reinstall the LLGo-compiled tools
2. **Run `go test -v ./cl/internal/convert -run TestFromTestdata`** to verify the changes
3. **If test output changes are expected**, temporarily set `gen:true` in the test to regenerate expected output (`gogensig.expect`), verify it is correct, then set back to `gen:false`
4. **Do NOT skip these tests or mark them as "requires CI"** — they can and should be run locally after `install.sh`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove these line!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

@fennoai fennoai Bot Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed line 92 (Do NOT skip these tests or mark them as "requires CI"...) per request. Pushed in commit ff9865d.

Generated with [codeagent](https://github.com/qbox/codeagent)
Co-authored-by: luoliwoshang <51194195+luoliwoshang@users.noreply.github.com>
Comment thread CLAUDE.md
Added guidance to run unit tests (e.g., _xtool/internal/parser,
_xtool/internal/header) before running dependent tests like
TestFromTestdata, to verify modified packages work correctly first.

Generated with [codeagent](https://github.com/qbox/codeagent)
Co-authored-by: luoliwoshang <51194195+luoliwoshang@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@luoliwoshang luoliwoshang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@luoliwoshang luoliwoshang merged commit 26d0726 into main Feb 11, 2026
9 of 10 checks passed
@fennoai fennoai Bot deleted the xgopilot/issue-638-1770809654 branch February 11, 2026 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: update CLAUDE.md to instruct AI to run install.sh and TestFromTestdata locally

3 participants