Skip to content

[no-ci] Mention mostly the ability to automatically update submodules - #3105

Open
seberg wants to merge 2 commits into
NVIDIA:mainfrom
seberg:submodule-recurse-doc
Open

seberg wants to merge 2 commits into
NVIDIA:mainfrom
seberg:submodule-recurse-doc

Conversation

@seberg

@seberg seberg commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Expand docs slightly to mention that you can set up your clone to automatically keep submodules up to date.

@rwgk is this roughly what you are looking for?

Expand docs slightly to mention that you can set up your clone to automatically
keep submodules up to date.
@seberg seberg added this to the cuda.core 1.3.0 milestone Oct 14, 2026
@seberg
seberg requested a review from rwgk October 14, 2026 12:02
@seberg seberg self-assigned this Oct 14, 2026
@seberg seberg added documentation Improvements or additions to documentation P2 Low priority - Nice to have cuda.core Everything related to the cuda.core module labels Oct 14, 2026
@coderabbitai

coderabbitai Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/cuda-python/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 5d8fdfc1-2810-4d62-9b01-7536893430ce
📥 Commits

Reviewing files that changed from the base of the PR and between 31915ee and 0f5f25e.

📒 Files selected for processing: 1
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated cloning guidance to initialize submodules recursively and documented recursive submodule updates when pulling, checking out, or switching branches. Pushes do not update submodules recursively.
    • Added an “Updating your clone” section explaining how to initialize newly added submodules, and linked to it from the table of contents.

CONTRIBUTING.md now recommends recursive cloning and documents Git settings for submodule updates. It also explains how to pull updates and initialize newly added submodules.

Changes: Clone submodule updates

Layer / File(s) Summary
Document submodule update methods
CONTRIBUTING.md
The table of contents links to the update guidance. The cloning instructions describe recursive cloning, submodule recursion settings for pull, checkout, and switch, and disabling recursive pushes. The update guidance covers pulling and initializing newly added submodules.

Priority: ⬇️ Low

Change: Other

Merge Risk: ⚪ Minimal · up to 0f5f2

The submodule guidance covers recursive updates without unexpectedly recursing on pushes, and provides a general initialization step after updates. No material merge risk remains.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

✨ Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/cuda-python/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 78a91f92-c74c-4dcc-9f43-4037f0a89fe7
📥 Commits

Reviewing files that changed from the base of the PR and between 1cd41ea and 31915ee.

📒 Files selected for processing: 1
  • CONTRIBUTING.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

@rwgk rwgk left a comment

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.

I went ahead and added a commit to simplify/polish the new sections. The changes take the coderabbit suggestions into account.

@rwgk rwgk changed the title Mention mostly the ability to automatically update submodules [no-ci] Mention mostly the ability to automatically update submodules Oct 14, 2026
@rwgk

rwgk commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Closing / re-opening to re-trigger GHA after adding [no-ci].

@rwgk rwgk closed this Oct 14, 2026
@rwgk rwgk reopened this Oct 14, 2026

This branch has not been deployed

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

Labels

cuda.core Everything related to the cuda.core module documentation Improvements or additions to documentation P2 Low priority - Nice to have

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants