From d1eefe631428950555b62356fca5d10e7d7ba5ea Mon Sep 17 00:00:00 2001 From: Michael Dowling Date: Mon, 31 Jul 2023 11:58:43 -0500 Subject: [PATCH] Add naming recommendations Closes #1785 --- docs/source-2.0/guides/style-guide.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/source-2.0/guides/style-guide.rst b/docs/source-2.0/guides/style-guide.rst index 9f5886dcbed..a7446cd0614 100644 --- a/docs/source-2.0/guides/style-guide.rst +++ b/docs/source-2.0/guides/style-guide.rst @@ -173,7 +173,16 @@ Naming Shape names ----------- -Shape names use a strict form of UpperCamelCase (e.g., "XmlRequest", "FooId"). +* Shape names use a strict form of UpperCamelCase (e.g., "XmlRequest", "FooId"). +* Numeric shapes should use descriptive names, including units of measurement + (e.g., prefer "SizeInMb" over "Size"). +* Enums should use a singular noun (e.g., prefer "Suit" over "Suits"). +* Lists should use plural names (e.g., prefer "Users" over "UserList"). +* Operations should follow the format of "VerbNoun" (e.g., "UpdateUser"). +* Resources should use a singular noun (e.g., use "User" over "Users"). +* Services should be named after the name of a service, omitting the word + "Service" and branding when possible (e.g., prefer "S3" over + "AmazonS3Service"). Member names