Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Co-authored-by: Manushak Keramyan <[email protected]>
Signed-off-by: Joseph Cook <[email protected]>
  • Loading branch information
jmcook1186 and manushak authored Dec 5, 2024
1 parent c9dff9d commit 52b95fc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 52b95fc

Please sign in to comment.