From 52b95fca008372075954207ad64857be5caf6174 Mon Sep 17 00:00:00 2001 From: Joseph Cook <33655003+jmcook1186@users.noreply.github.com> Date: Thu, 5 Dec 2024 10:31:54 +0000 Subject: [PATCH] Update CONTRIBUTING.md Co-authored-by: Manushak Keramyan Signed-off-by: Joseph Cook <33655003+jmcook1186@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45fd5627..29a7eeae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -191,7 +191,7 @@ We prefer not to use abbreviations of contractions in parameter names. Using fully descriptive names makes the code more readable, which in turn helps reviewers and anyone else aiming to understand how the plugin works. -It also helps to avoid ambiguity and naming collisions within and across plugins. Your name should describe what an element does as precisely as practically possible. +It also helps to avoid ambiguity and naming collisions within and across plugins. Ensure that names clearly and precisely describe the purpose of an element to make its functionality immediately apparent. For example, we prefer `functionalUnit` to `funcUnit`, `fUnit`, or any other abbreviation.