mirror of
https://github.com/andreinechaev/nvcc4jupyter.git
synced 2026-06-15 19:50:50 +05:30
Update contributing instructions
This commit is contained in:
@@ -46,6 +46,7 @@ Here are just a few of the things that nvcc4jupyter does well:
|
|||||||
|
|
||||||
- [Easily run CUDA C++ code](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#hello-world)
|
- [Easily run CUDA C++ code](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#hello-world)
|
||||||
- [Profile your code with NVIDIA Nsight Compute](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#profiling)
|
- [Profile your code with NVIDIA Nsight Compute](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#profiling)
|
||||||
|
- [Compile your code with external libraries (e.g. OpenCV)](https://nvcc4jupyter.readthedocs.io/en/latest/notebooks.html#compiling-with-external-libraries)
|
||||||
- [Share code between different programs in the same notebook / split your code into multiple files for improved readability](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#groups)
|
- [Share code between different programs in the same notebook / split your code into multiple files for improved readability](https://nvcc4jupyter.readthedocs.io/en/latest/usage.html#groups)
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
@@ -88,13 +89,14 @@ The official documentation is hosted on [readthedocs](https://nvcc4jupyter.readt
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Install the package with the development dependencies:
|
The recommended setup for development is using the devcontainer in GitHub
|
||||||
|
Codespaces or locally in VSCode.
|
||||||
|
|
||||||
|
If not using the devcontainer you need to install the package with the
|
||||||
|
development dependencies and install the pre-commit hook before commiting any
|
||||||
|
changes:
|
||||||
```bash
|
```bash
|
||||||
pip install .[dev]
|
pip install .[dev]
|
||||||
```
|
|
||||||
|
|
||||||
As a developer, make sure you install the pre-commit hook before commiting any changes:
|
|
||||||
```bash
|
|
||||||
pre-commit install
|
pre-commit install
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user