From a68e6e65e9e7e9ebbd8d500c4fe834362fccc81a Mon Sep 17 00:00:00 2001 From: David Wendt <45795991+davidwendt@users.noreply.github.com> Date: Thu, 28 Jul 2022 21:00:16 -0400 Subject: [PATCH] Update contributing doc to include links to the developer guides (#11390) Adds links to the developer guides to the contributing.md Closes #11348 Authors: - David Wendt (https://github.com/davidwendt) Approvers: - Mark Harris (https://github.com/harrism) - Vyas Ramasubramani (https://github.com/vyasr) URL: https://github.com/rapidsai/cudf/pull/11390 --- CONTRIBUTING.md | 7 +++++++ docs/cudf/README.md | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f9f7dc929ad..38a57caa5f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -380,6 +380,13 @@ Now code linters and formatters will be run each time you commit changes. You can skip these checks with `git commit --no-verify` or with the short version `git commit -n`. +## Developer Guidelines + +The [C++ Developer Guide](cpp/docs/DEVELOPER_GUIDE.md) includes details on contributing to libcudf C++ code. + +The [Python Developer Guide](https://docs.rapids.ai/api/cudf/stable/developer_guide/index.html) includes details on contributing to cuDF Python code. + + ## Attribution Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md diff --git a/docs/cudf/README.md b/docs/cudf/README.md index cea6e8f5f37..6d07ec561bf 100644 --- a/docs/cudf/README.md +++ b/docs/cudf/README.md @@ -3,4 +3,4 @@ This directory contains the documentation of cuDF Python. For more information on how to write, build, and read the documentation, see -[the developer documentation](https://github.com/rapidsai/cudf/blob/main/docs/cudf/source/developer_guide/documentation.md). +[the developer documentation](https://github.com/rapidsai/cudf/blob/HEAD/docs/cudf/source/developer_guide/documentation.md).