CUDA C++ Contributing Guide

[gevtushenko]

No description provided.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[github-actions]

👋 Thank you for your contribution!

This pull request is from a forked repository so GitHub Actions will not be able to run CI. A maintainer will review your changes shortly and manually trigger the CI.

@maintainers Please review this PR when you have a chance and follow the instructions in the CONTRIBUTING.md file to trigger the CI.

[github-actions]

⚠️ Unsigned Commits Detected

This pull request contains 1 unsigned commit(s):

• 657cefe CUDA C++ Contriguting Guide

All commits must be signed before this PR can be merged. Please sign your commits by following these steps:

Option 1: SSH Key Signing (Recommended)

1. Add your SSH key to GitHub (if not already done):

   • Go to GitHub SSH Keys Settings
   • Click "New SSH Key" and select "Signing Key" as the key type

2. Configure Git to use SSH signing:

   git config --global gpg.format ssh
   git config --global user.signingkey ~/.ssh/id_ed25519.pub  # or your key path
   git config --global commit.gpgsign true

3. Re-sign your commits:

   git rebase -i HEAD~1 --exec "git commit --amend --no-edit -S"
   git push --force

Option 2: GPG Key Signing

1. Generate a GPG key: GitHub Docs

2. Add the GPG key to GitHub: GitHub Docs

3. Configure Git to sign commits:

   git config --global user.signingkey YOUR_GPG_KEY_ID
   git config --global commit.gpgsign true

4. Re-sign your commits (same as above):

   git rebase -i HEAD~1 --exec "git commit --amend --no-edit -S"
   git push --force

For more details, see GitHub's commit signature verification docs.

---

This comment will be updated when you push new commits.

[smish-nvidia]

Looks good to me!

[smish-nvidia]

these nested code fences seem to be formatted incorrectly, but I'm not sure how to escape the backticks

[smish-nvidia]

when I tried to follow this link from the markdown page, it seemed to be broken

[smish-nvidia]

Are these requirements or "nice-to-have"s for the images and figures?

[bernhardmgruber]

AFAIK all images follow this style (excalidraw + vector graphics). We should aim to retain it.

[brycelelbach]

To avoid rerunning the install commands multiple times, do something like:

if os.getenv("COLAB_RELEASE_TAG") and not os.path.exists("/accelerated-computing-hub-installed"): # If running in Google Colab:
  # ...
  open("/accelerated-computing-hub-installed", "a").close()

[brycelelbach]

You should link to the top-level docs in docs/ of the repo which document the ACH tutorial structure and Brev setup.

[brycelelbach]

Looks good, I left a few minor notes.

[brycelelbach]

@gevtushenko the link check is failing because it's failing to find the theoretical source file you reference in the doc.

Error: R] <file:///home/runner/work/accelerated-computing-hub/accelerated-computing-hub/tutorials/cuda-cpp/Solutions/no-magic-execution-space-changes.cpp> | Cannot find file: File not found. Check if file exists and path is correct

You should add that file path to $REPO_ROOT/brev/.lycheeignore.

[brycelelbach]

Please fix the false positive link check failure. It's failing to find the theoretical source file you reference in the doc.

Error: R] <file:///home/runner/work/accelerated-computing-hub/accelerated-computing-hub/tutorials/cuda-cpp/Solutions/no-magic-execution-space-changes.cpp> | Cannot find file: File not found. Check if file exists and path is correct

You should add that file path to $REPO_ROOT/brev/.lycheeignore.