Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: keeping CONTRIBUTING.md up to date (take 1) #3038

Merged
merged 3 commits into from
Mar 20, 2024
Merged

chore: keeping CONTRIBUTING.md up to date (take 1) #3038

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
878b2bc
chore: keeping CONTRIBUTING.md up to date (take 1)
jpivarski Mar 4, 2024
869802e
chore: add a section for unit tests
ManasviGoyal Mar 6, 2024
a5ad8d5
include tcawlfield in the list of regular reviewers
jpivarski Mar 20, 2024
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
25 changes: 22 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ Please [make the pull request a draft](https://github.blog/2019-02-14-introducin

### Getting your pull request reviewed

Currently, we have three regular reviewers of pull requests:
Currently, we have two regular reviewers of pull requests:

* Angus Hollands ([agoose77](https://github.com/agoose77))
* Ioana Ifrim ([ioanaif](https://github.com/ioanaif))
* Jim Pivarski ([jpivarski](https://github.com/jpivarski))
* Topher Cawlfield ([tcawlfield](https://github.com/tcawlfield))

You can request a review from one of us or just comment in GitHub that you want a review and we'll see it. Only one review is required to be allowed to merge a pull request. We'll work with you to get it into shape.

Expand Down Expand Up @@ -143,6 +142,26 @@ python -m pytest tests-cuda-kernels
python -m pytest tests-cuda
```

#### Unit tests for the kernels

You can also run additional unit tests that have more test coverage for all the low-level kernels for even more detailed fine-grained testing.

For Python Kernels:
```bash
python -m pytest -n auto awkward-cpp/tests-spec-explicit
```

For CPU Kernels:
```bash
python -m pytest -n auto awkward-cpp/tests-cpu-kernels-explicit
```

For CUDA Kernels
```bash
python -m pytest tests-cuda-kernels-explicit
```


### Building wheels

Sometimes it's convenient to build a wheel for the `awkward-cpp` package, so that subsequent re-installs do not require the package to be rebuilt. The `build` package can be used to do this, though care must be taken to specify the *current* Python interpreter in [pipx](https://pypa.github.io/pipx/):
Expand Down