You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by an...@apache.org on 2022/11/02 11:14:26 UTC

[jackrabbit-oak] 01/04: improve exercise readme

This is an automated email from the ASF dual-hosted git repository.

angela pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git

commit 0047f1a9f2f1a6fe125fa584a05d801538d60e98
Author: angela <an...@adobe.com>
AuthorDate: Wed Nov 2 09:16:55 2022 +0100

    improve exercise readme
---
 oak-exercise/README.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/oak-exercise/README.md b/oak-exercise/README.md
index a424d0fbf7..991de81cb1 100644
--- a/oak-exercise/README.md
+++ b/oak-exercise/README.md
@@ -117,9 +117,16 @@ General Security
 Using the Exercise Module
 -------------------------
 
-TODO
+The exercise module consists of training material in the form of test-cases that are to be 'fixed' based on the 
+instructions in the description and the test-method (EXERCISE comments).
+In addition the module comes with examples for customizations and extensions that can be adjusted and plugged 
+into an test repository for advanced learners.
 
 How to Verify your Solutions
 ----------------------------
 
-TODO
\ No newline at end of file
+The instructions and the EXERCISE comments indicate how the tests need to be adjusted. 
+Run the tests in your IDE and verify that they pass to check if your solution is correct.
+
+NOTE: The module by default skips test execution. Enable test verification if you intend to verify your solutions with 
+'mvn clean install'.
\ No newline at end of file