collection_requirements.rst: add naming recommendations (#103)

ansible-collections · Aug 6, 2020 · 6823cc1 · 6823cc1
1 parent 1ba7759
commit 6823cc1
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/collection_requirements.rst b/collection_requirements.rst
@@ -110,7 +110,13 @@ Repository management
 Repository name
 ---------------
 
-For collections under ansible-collections the repo SHOULD be named ``NAMESPACE.COLLECTION``
+For collections under ansible-collections the repository SHOULD be named ``NAMESPACE.COLLECTION``.
+
+For collections created for working with a particular entity, they should contain the entity name, for example ``community.mysql``.
+
+We should avoid:
+* too long FQCN names: try to make it compact but clear
+* nested namespaces if this is not really necessary, especially namespaces with repetitive parts
 
 Branch name and configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~