Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,32 +35,34 @@ into three categories:
Remember, if you are unsure about anything, don't hesitate to comment on issues
and ask for clarifications!

## Pre-commit checks
## Installation of Development Dependencies

Numba-CUDA uses [`pre-commit`](https://pre-commit.com/) to run a number of style
checks in CI. To ensure your contribution will pass the checks, you can also set
up pre-commit locally to run the checks prior to committing.
There are some dependencies that are required for developing Numba-CUDA, but are not required for installation or distribution.
These dependencies are listed under the `test-cu11` and `test-cu12` optional dependency groups in our project configuration.

To set up pre-commit with Numba-CUDA, run
To install Numba-CUDA for development, run this in the root of the repository:

```shell
pip install -e ".[test-cu11]"
```
pip install pre-commit
```

or

```
conda install pre-commit
```sh
pip install -e ".[test-cu12]"
```

depending on your package manager, then run
Numba-CUDA uses [`pre-commit`](https://pre-commit.com/) to run a number of style
checks in CI. To ensure your contribution will pass the checks, you can also set
up pre-commit locally to run the checks prior to committing.

```
```shell
# This will run a small set of checks every time you commit.
pre-commit install
```

in the root of the Numba-CUDA repository to set up the pre-commit hooks to run
checks prior to each commit.
To run them manually without committing, run this in the root of the repository:
```shell
pre-commit run --all-files
```

## Releases

Expand Down
18 changes: 3 additions & 15 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,35 +39,23 @@ cu12 = [
"nvidia-nvjitlink-cu12"
]
test = [
"pre-commit",
"psutil",
"cffi",
"pytest",
"pytest-xdist",
"filecheck",
]
test-cu11 = [
"numba-cuda[cu11]",
"numba-cuda[test]",
"nvidia-curand-cu11",
]
test-cu12 = [
"numba-cuda[cu12]",
"numba-cuda[test]",
"nvidia-curand-cu12",
]
dev = [
"pre-commit",
"numba-cuda[test]",
]
dev-cu11 = [
"numba-cuda[test-cu11]",
"numba-cuda[test]",
"numba-cuda[dev]",
]
dev-cu12 = [
"numba-cuda[test-cu12]",
"numba-cuda[test]",
"numba-cuda[dev]",
]


[project.urls]
Homepage = "https://nvidia.github.io/numba-cuda/"
Expand Down