Skip to content

Comments

docs: add submodule update step before test runs#11576

Merged
kdy1 merged 1 commit intomainfrom
kdy1/update-agents-submodule-testing
Feb 23, 2026
Merged

docs: add submodule update step before test runs#11576
kdy1 merged 1 commit intomainfrom
kdy1/update-agents-submodule-testing

Conversation

@kdy1
Copy link
Member

@kdy1 kdy1 commented Feb 23, 2026

Summary

  • add a testing instruction in AGENTS.md
  • require running git submodule update --init --recursive before any test execution

Testing

  • not run (documentation-only change)

Copilot AI review requested due to automatic review settings February 23, 2026 19:07
@kdy1 kdy1 requested a review from a team as a code owner February 23, 2026 19:07
@changeset-bot
Copy link

changeset-bot bot commented Feb 23, 2026

⚠️ No Changeset found

Latest commit: ec4c8fc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@kdy1 kdy1 merged commit 81b22c3 into main Feb 23, 2026
22 checks passed
@kdy1 kdy1 deleted the kdy1/update-agents-submodule-testing branch February 23, 2026 19:07
@github-actions github-actions bot added this to the Planned milestone Feb 23, 2026
@claude
Copy link
Contributor

claude bot commented Feb 23, 2026

PR Review: docs: add submodule update step before test runs

Summary: This is a documentation-only change that adds a single line to AGENTS.md instructing AI agents to run git submodule update --init --recursive before running tests.

Assessment

LGTM. This is a sensible and well-placed addition. The repo has three git submodules (test262-parser-tests, html5lib-tests, decorator-tests) that are used by test fixtures in swc_ecma_parser, swc_html_parser, and swc_ecma_transforms_proposal. Without initializing these submodules, test runs in those crates will fail or produce misleading results.

Minor observations

  1. Placement: The instruction is well-placed in the Testing section, right after the general testing guidelines and before the UPDATE=1 hint. This ensures agents see it early in the testing workflow.

  2. Potential improvement (non-blocking): The instruction could also be mentioned in the Verification section, since that section describes the full pre-completion checklist. However, it's reasonable to assume agents will read the Testing section before reaching Verification, so the current placement should be sufficient.

  3. Idempotency: git submodule update --init --recursive is safe to run repeatedly, so there's no risk of agents running it unnecessarily — good choice of command.

No issues with code quality, security, or correctness. Straightforward documentation improvement.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This documentation-only PR adds a testing instruction to AGENTS.md that requires running git submodule update --init --recursive before executing tests. The repository contains three git submodules used for test fixtures (test262-parser-tests, html5lib-tests, and decorator-tests), making this instruction necessary for proper test execution.

Changes:

  • Added instruction to run git submodule update --init --recursive before running tests in AGENTS.md

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

Binary Sizes

File Size
swc.linux-x64-gnu.node 28M (28582344 bytes)

Commit: a5a4e06

@codspeed-hq
Copy link

codspeed-hq bot commented Feb 23, 2026

Merging this PR will degrade performance by 2.02%

❌ 1 regressed benchmark
✅ 183 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Benchmark BASE HEAD Efficiency
es/oxc/benches/assets/UserSettings.tsx/sourceMap=true/reactDev=true 1.4 ms 1.4 ms -2.02%

Comparing kdy1/update-agents-submodule-testing (ec4c8fc) with main (81b22c3)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (5a02692) during the generation of this report, so 81b22c3 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant