corda/experimental/README.md

12 lines
836 B
Markdown
Raw Permalink Normal View History

2016-06-22 13:02:50 +00:00
# Experimental module
2016-11-29 10:30:49 +00:00
The purpose of this module is to hold code that isn't yet ready for code review, but which still wants
2016-06-22 13:02:50 +00:00
to be refactored and kept compiling as the underlying platform changes. Code placed into experimental *must* eventually
2016-11-29 10:30:49 +00:00
either be moved into the main modules and go through code review, or be deleted.
2016-06-22 13:02:50 +00:00
Code placed here can be committed to directly onto master at any time as long as it doesn't break the build
(no compile failures or unit test failures). Any commits here that break the build will simply be rolled back.
To help reduce the build times, unit tests for experimental projects have been disabled and will NOT run alongside
the whole project tests run via Gradle. Add parameter ```experimental.test.enable``` (example command is ```gradlew test -Dexperimental.test.enable```
to enable those tests.