From 23f226ef0e28722c88b02866de9e08e3962bfafa Mon Sep 17 00:00:00 2001 From: Julia Jiang Date: Mon, 15 Apr 2024 11:03:34 -0400 Subject: [PATCH] SWDEV-449354 - Update HIP contributing md Change-Id: Ie2358ec79c6e93d4b6504de9428e9b653feb52f5 --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 026c335459..a63e03da67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Please use the [GitHub Issue](https://github.com/ROCm/HIP/issues) tab to notify ## Acceptance Criteria ## -HIP is a C++ Runtime API and Kernel Language that allows developers to create portable applications for AMD and NVIDIA GPUs from single source code. Contributors wishing to submit new HIP Features (ie functions, classes, types) should resemble CUDA APIs. +HIP is a C++ Runtime API and Kernel Language that allows developers to create portable applications for AMD and NVIDIA GPUs from single source code. Contributors wishing to submit new HIP Features (ie functions, classes, types) should also consider CUDA APIs. Differences or limitations of HIP APIs as compared to CUDA APIs should be clearly documented and described. Some guidelines are outlined below: @@ -51,7 +51,6 @@ For applications and benchmarks outside the hip-tests environment, developments - Use 4 spaces indentation. - Capitalization and Naming - Prefer camelCase for HIP interfaces and internal symbols. Note HCC uses _ for separator. - This guideline is not yet consistently followed in HIP code - eventual compliance is aspirational. - Member variables should begin with a leading "_". This allows them to be easily distinguished from other variables or functions. - `{}` placement