Skip to content

Fix Docker building instructions#2586

Open
janEbert wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
janEbert:init-submodules
Open

Fix Docker building instructions#2586
janEbert wants to merge 1 commit intoNVIDIA-NeMo:mainfrom
janEbert:init-submodules

Conversation

@janEbert
Copy link
Copy Markdown
Contributor

@janEbert janEbert commented Feb 27, 2026

What does this PR do ?

It's never mentioned that the Megatron-LM submodule has to be initialized, even though it's used in the Dockerfile. So these instructions are added.

Changelog

  • Add submodule initialization to Docker build instructions.

Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated contribution guide with setup instructions for third-party submodules.
    • Added clarified Docker build command instructions for contributors.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Feb 27, 2026

📝 Walkthrough

Walkthrough

The pull request adds setup instructions for Git submodules and includes a concrete Docker build command in CONTRIBUTING.md, specifying the use of docker/Dockerfile.ci with the megatron-bridge image tag.

Changes

Cohort / File(s) Summary
Documentation Updates
CONTRIBUTING.md
Added Git submodule initialization step (git submodule update --init --recursive) and a concrete docker build command using -f docker/Dockerfile.ci -t megatron-bridge.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding Docker build instructions, which directly corresponds to the PR's objective of documenting the submodule initialization step needed for Docker builds.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Results For Major Changes ✅ Passed This PR contains only a minor documentation update to CONTRIBUTING.md that clarifies Git submodule initialization, with zero code changes and 8 lines added.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

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.

1 participant