From 73599e0b572a4c24bd52c74053c4f6871d35c036 Mon Sep 17 00:00:00 2001 From: Jake Hemstad Date: Wed, 27 Sep 2023 15:18:51 +0000 Subject: [PATCH] [skip ci] Add developer guides. --- CONTRIBUTING.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3b782cb96..cf5b64a640 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,6 +92,27 @@ See the [Dev Containers guide](.devcontainer/README.md) for instructions on how ```bash git commit -m "Add a brief description of the change" ``` +### Developer Guides + +As CCCL evolves, we are in the process of unifying and consolidating our practices and guidelines across all components. However, due to the unique history and characteristics of each component, there are still aspects specific to each one. To aid your contributions and ensure you're aligned with each component's best practices, we offer detailed developer guides: + +#### CUB +- [CUB Developer Guide](cub/docs/developer_overview.rst) - General overview of the design of CUB internals +- [CUB Test Overview](cub/docs/test_overview.rst) - Overview of how to write CUB unit tets +- [CUB Tuning Infrastructure](cub/docs/tuning.rst) - Overview of CUB's performance tuning infrastructure +- [CUB Benchmarks](cub/docs/benchmarking.rst) - Overview of CUB's performance benchmarks + +#### Thrust + +Coming soon! + +#### libcudacxx + +Coming soon! + + + +These guides delve deeper into the specifics of each library and will be invaluable if you're looking to make substantial changes or additions. ## Building and Testing