diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aa51259a90b..f8fd8ccb381 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ ## Description - + closes @@ -8,6 +8,6 @@ closes ## Checklist - +- [ ] I have read the [Contributing Guidelines](https://github.com/NVIDIA/cuda-python/blob/main/CONTRIBUTING.md#coordinate-before-implementing). - [ ] New or existing tests cover these changes. - [ ] The documentation is up to date with these changes. diff --git a/AGENTS.md b/AGENTS.md index b50bd9e1ca3..55e92ba91d1 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -44,6 +44,14 @@ pre-tag bootstrap should validate the resulting release tuple rather than hard-code the expected alpha/development suffix, and should report the effective `git describe` result for traceability. +# Contributions + +Before starting implementation or preparing an issue or PR, follow the +[contribution guidelines](CONTRIBUTING.md#coordinate-before-implementing). + +For an external contribution, briefly explain any unmet coordination requirement +for that change and the next step before starting implementation. + # Pull requests Treat the canonical upstream repository as read-only by default. For normal diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3783380d46..d1e1944b7f8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,24 +1,13 @@ # Contributing to CUDA Python -Thank you for your interest in contributing to CUDA Python! Based on the type of contribution, it will fall into two categories: - -1. You want to report a bug, feature request, or documentation issue: - - File an [issue](https://github.com/NVIDIA/cuda-python/issues/new/choose) - describing what you encountered or what you want to see changed. - - The NVIDIA team will evaluate the issues and triage them, scheduling - them for a release. If you believe the issue needs priority attention - comment on the issue to notify the team. -2. You want to implement a feature, improvement, or bug fix: - - Before starting work on an existing issue, please comment on the issue to express your interest and wait to be assigned by a maintainer. This helps avoid redundant effort in case the issue is already being worked on by another contributor or an NVIDIA team member. - - Please refer to each component's guideline: - - [`cuda.core`](https://nvidia.github.io/cuda-python/cuda-core/latest/contribute.html) - - [`cuda.bindings`](https://nvidia.github.io/cuda-python/cuda-bindings/latest/contribute.html)[1](#footnote1) - - [`cuda.pathfinder`](https://nvidia.github.io/cuda-python/cuda-pathfinder/latest/contribute.html) +Thank you for your interest in contributing to CUDA Python! Bug reports, +reproducers, documentation improvements, and code changes are welcome. ## Table of Contents - [Contributing to CUDA Python](#contributing-to-cuda-python) - [Table of Contents](#table-of-contents) + - [Coordinate before implementing](#coordinate-before-implementing) - [Cloning the repository](#cloning-the-repository) - [Recommended clone](#recommended-clone) - [Updating your clone](#updating-your-clone) @@ -32,6 +21,7 @@ Thank you for your interest in contributing to CUDA Python! Based on the type of - [Review Guidance](#review-guidance) - [Pull Request Reviews](#pull-request-reviews) - [Pixi lockfiles](#pixi-lockfiles) + - [Secret Scanning](#secret-scanning) - [Signing Your Work](#signing-your-work) - [Code signing](#code-signing) - [Developer Certificate of Origin (DCO)](#developer-certificate-of-origin-dco) @@ -45,6 +35,27 @@ Thank you for your interest in contributing to CUDA Python! Based on the type of - [Code coverage](#code-coverage) +## Coordinate before implementing + +Review capacity is limited. If you are contributing from outside NVIDIA: + +- **Existing issue:** comment and wait for a maintainer to assign it to you or + explicitly ask you to implement it. Check existing assignments and requests + to take the issue. +- **New features, design changes, or CI/release infrastructure:** open an issue + and agree on scope and validation before implementing. +- **Small standalone bug or documentation fixes without an existing issue:** + a direct PR is welcome. Explain the problem and how you checked the fix. + +NVIDIA contributors may use normal team planning and self-assignment. + +Feel free to report a bug or send reproducers, measurements, and suggestions +without an assignment. Include relevant versions and expected versus observed +behavior in bug reports. + +Keep changes focused, understand the complete diff, and report which checks +ran and any validation gaps. + ## Cloning the repository ### Recommended clone @@ -462,7 +473,3 @@ The CI pipeline diagram is maintained as Mermaid source in [`ci/ci-pipeline.mmd` Code coverage reports are produced nightly and posted to [GitHub Pages](https://nvidia.github.io/cuda-python/coverage). Known limitations: Code coverage is only run on Linux x86_64 with an a100 GPU. We plan to add more platform and GPU coverage in the future. - ---- - -1: The `cuda-python` meta package shares the same license and the contributing guidelines as those of `cuda-bindings`. diff --git a/cuda_bindings_13/docs/source/contribute.rst b/cuda_bindings_13/docs/source/contribute.rst index f2a4fc9c53d..f70d551fa8c 100644 --- a/cuda_bindings_13/docs/source/contribute.rst +++ b/cuda_bindings_13/docs/source/contribute.rst @@ -1,27 +1,12 @@ .. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. .. SPDX-License-Identifier: Apache-2.0 +.. _contributor_guide: + Contributing ============ -Thank you for your interest in contributing to ``cuda-bindings``! Based on the -type of contribution, it will fall into two categories: - -1. You want to report a bug, feature request, or documentation issue. - - File an `issue `_ - describing what you encountered or what you want to see changed. The NVIDIA - team will evaluate the issue, triage it, and schedule it for a release. If - you believe the issue needs priority attention, comment on the issue to - notify the team. - -2. You want to implement a feature, improvement, or bug fix. - - Before starting work on an existing issue, comment on the issue to express - your interest and wait to be assigned by a maintainer. This helps avoid - redundant effort. - - Follow the repository `contribution guide - `_, including - signing off each commit under the Developer Certificate of Origin (DCO) and - cryptographically signing commits. +Thank you for your interest in contributing to ``cuda-bindings``! +Please follow the repository `contribution guide +`_ for +coordination, validation, and commit signing. diff --git a/cuda_core/docs/source/contribute.rst b/cuda_core/docs/source/contribute.rst index 45a86931299..6242c362725 100644 --- a/cuda_core/docs/source/contribute.rst +++ b/cuda_core/docs/source/contribute.rst @@ -1,4 +1,4 @@ -.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. .. SPDX-License-Identifier: Apache-2.0 .. _contributor_guide: @@ -6,17 +6,7 @@ Contributing ------------ -Thank you for your interest in contributing to ``cuda-core``! Based on the type of contribution, it will fall into two categories: - -1. You want to report a bug, feature request, or documentation issue - - - File an `issue `_ - describing what you encountered or what you want to see changed. - - The NVIDIA team will evaluate the issues and triage them, scheduling - them for a release. If you believe the issue needs priority attention - comment on the issue to notify the team. - -2. You want to implement a feature, improvement, or bug fix: - - - Before starting work on an existing issue, please comment on the issue to express your interest and wait to be assigned by a maintainer. This helps avoid redundant effort in case the issue is already being worked on by another contributor or an NVIDIA team member. - - Please ensure that your commits are signed `following GitHub's instruction `_. +Thank you for your interest in contributing to ``cuda-core``! +Please follow the repository `contribution guide +`_ for +coordination, validation, and commit signing. diff --git a/cuda_pathfinder/docs/source/contribute.rst b/cuda_pathfinder/docs/source/contribute.rst index 0c0f4c71b31..16b9eea35ea 100644 --- a/cuda_pathfinder/docs/source/contribute.rst +++ b/cuda_pathfinder/docs/source/contribute.rst @@ -1,4 +1,4 @@ -.. SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. +.. SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. .. SPDX-License-Identifier: Apache-2.0 .. _contributor_guide: @@ -6,13 +6,7 @@ Contributing ============ -Thank you for your interest in contributing to ``cuda-pathfinder``! Based on the type of contribution, it will fall into two categories: - -1. You want to report a bug, feature request, or documentation issue - - File an `issue `_ describing what you encountered or what you want to see changed. - - The NVIDIA team will evaluate the issues and triage them, scheduling - them for a release. If you believe the issue needs priority attention - comment on the issue to notify the team. -2. You want to implement a feature, improvement, or bug fix - - Before starting work on an existing issue, please comment on the issue to express your interest and wait to be assigned by a maintainer. This helps avoid redundant effort in case the issue is already being worked on by another contributor or an NVIDIA team member. - - Please ensure that your commits are signed `following GitHub's instruction `_. +Thank you for your interest in contributing to ``cuda-pathfinder``! +Please follow the repository `contribution guide +`_ for +coordination, validation, and commit signing.