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.

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

[DOC]: Update contributing guide to include information on how to use cmake presets #1689

Closed
1 task done
jrhemstad opened this issue May 2, 2024 · 0 comments · Fixed by #1694
Closed
1 task done
Assignees
Labels
doc Documentation-related items.

Comments

@jrhemstad
Copy link
Collaborator

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

New

Describe the incorrect/future/missing documentation

As a maintainer and contributor to CCCL, I want to know how to conveniently and easily build and execute CCCL's tests.

The current contributor guide provides information on using the ci/build_* and ci/test_* scripts, but it should also provide guidance on using the cmake presets. This should include information on using the cmake presets directly on the command line, as well as using the cmake vscode extension in our devcontainers.

The desired structure would be something like:

## Building and Testing

CCCL components are header-only libraries. This means there isn't a traditional build process for the library itself. However, before submitting contributions, it's a good idea to build and run tests.

There are multiple options for building and running our tests, which you choose depends on your preferences and if you are using [CCCL's DevContainers](.devcontainer/README.md) (highly recommended!). 

### Using Manual Build Scripts
#### Build
// existing stuff
#### Test
// existing stuff

### Using CMake Presets
// 1-2 sentence description of what cmake presets are w/ link
#### Using CMake Presets via Command Line
// Show code block using presets via cli

#### Using CMake Presets via VSCode GUI (Recommended when using DevContainers)
// Show how to configure presets in cmake extension in devcontainer
// Include screenshots

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

No response

@jrhemstad jrhemstad added the doc Documentation-related items. label May 2, 2024
@gonidelis gonidelis self-assigned this May 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants