[18/27] tomee git commit: TOMEE-2326 - Define description and rules to create new examples

[jg...@apache.org]

TOMEE-2326 - Define description and rules to create new examples

Signed-off-by: brunobat <br...@gmail.com>


Project: http://git-wip-us.apache.org/repos/asf/tomee/repo
Commit: http://git-wip-us.apache.org/repos/asf/tomee/commit/fed45505
Tree: http://git-wip-us.apache.org/repos/asf/tomee/tree/fed45505
Diff: http://git-wip-us.apache.org/repos/asf/tomee/diff/fed45505

Branch: refs/heads/master
Commit: fed45505b0cad0185708c3555fb6c2c552a7213f
Parents: 7d54b67
Author: brunobat <br...@gmail.com>
Authored: Thu Dec 6 13:40:11 2018 +0000
Committer: brunobat <br...@gmail.com>
Committed: Thu Dec 6 15:01:24 2018 +0000

----------------------------------------------------------------------
 examples/README.adoc | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tomee/blob/fed45505/examples/README.adoc
----------------------------------------------------------------------
diff --git a/examples/README.adoc b/examples/README.adoc
new file mode 100644
index 0000000..294453e
--- /dev/null
+++ b/examples/README.adoc
@@ -0,0 +1,21 @@
+= TomEE Examples
+
+These examples demonstrate particular features of the JEE ecosystem to help
+developers in the creation of their own applications.
+
+The idea is that each example focuses in a very specific framework feature and
+demonstrates it's usage and behaviour in a simple way.
+
+== Rules to create a new example.
+
+* Demo just one feaure with simple business logic.
+* Don't use more than 4 names in the example's name.
+Like in the _cdi-basic_ example where @Inject is demontrated in the _Course_ class.
+* If your example has already 1000 lines, consider either simplifying it or split it.
+* Don't define a Parent in maven's _pom.xml_. This will make the project completely self contained and independent,
+making the required dependencies clear.
+* Make sure you only include dependencies that are realy needed.
+* Always include an integration test with Arquillian or ApplicationComposer.
+* Document the bahaviour of each method with javadoc.
+* Include a README file explining the purpose and what's doing on.
+* Make sure you add the new project to the parent project _pom.xml_ modules section.