Added API Reference convention and naming convention for tests (#3321)

* Added api reference convention and naming convention for tests

* Fix formatting

* update formating

Author: zoewangg

docs/design/APIReference.md

@@ -0,0 +1,8 @@
+**Design:** Convention, **Status:** [Accepted](README.md)
+
+## API Reference
+
+This page describes a general guideline for API Reference
+
+- Public APIs MUST have Javadocs, and the documentation MUST be properly formatted following [Javadoc format](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html)
+- Public Javadocs for high level libraries such as DyanmoDB Enhanced Client or hand-written utilitiy mehods MUST have code snippets as part of Javadocs

docs/design/NamingConventions.md

@@ -34,4 +34,8 @@ This page describes the naming conventions, nouns and common terms
     * Note: If only the only implementation uses async HTTP, `Async` may be excluded. (e.g. `S3TransferManager`)
 * If the class does not make service calls:
   * If the class creates presigned URLs: `{ServiceName}Presigner` (e.g. `S3Presigner`)
-  * If the class is a collection of various unrelated "helper" methods: `{ServiceName}Utilities` (e.g. `S3Utilities`)
+  * If the class is a collection of various unrelated "helper" methods: `{ServiceName}Utilities` (e.g. `S3Utilities`)
+
+### Tests Naming
+
+Test names SHOULD follow `methodToTest_when_expectedBehavior` (e.g. `close_withCustomExecutor_shouldNotCloseCustomExecutor`, `uploadDirectory_withDelimiter_filesSentCorrectly`)

docs/design/README.md

@@ -62,7 +62,8 @@ None
   [java.util.Optional](https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html).
 * [Completable Future Usage](UseOfCompletableFuture.md) - Conventions
   governing the use of
-  [java.util.concurrent.CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html).
+* [java.util.concurrent.CompletableFuture](https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html).
+* [APIReference](APIReference.md) - Conventions used for API references
 
 **Rejected**