From fed45505b0cad0185708c3555fb6c2c552a7213f Mon Sep 17 00:00:00 2001 From: brunobat Date: Thu, 6 Dec 2018 13:40:11 +0000 Subject: [PATCH 1/2] TOMEE-2326 - Define description and rules to create new examples Signed-off-by: brunobat --- examples/README.adoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 examples/README.adoc diff --git a/examples/README.adoc b/examples/README.adoc new file mode 100644 index 00000000000..294453e5708 --- /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. From 70eb624a0bc9fcc2a14cb00303676f5027c67857 Mon Sep 17 00:00:00 2001 From: brunobat Date: Thu, 6 Dec 2018 15:04:19 +0000 Subject: [PATCH 2/2] TOMEE-2326 - Address review requests Signed-off-by: brunobat --- examples/README.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/examples/README.adoc b/examples/README.adoc index 294453e5708..62b0ee76784 100644 --- a/examples/README.adoc +++ b/examples/README.adoc @@ -1,14 +1,14 @@ = TomEE Examples -These examples demonstrate particular features of the JEE ecosystem to help +These examples demonstrate particular features of the Java EE 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. +demonstrates its usage and behaviour in a simple way. == Rules to create a new example. -* Demo just one feaure with simple business logic. +* Demo just one feature 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.