Validation log

doc/ValidationLog.rst

@@ -0,0 +1,63 @@
+Validation Log
+==============
+
+Guidelines
+----------
+
+* All new features incorporated into a tagged release should have their validation documented.
+  * Document the new feature.
+  * Perform tests to validate the new feature.
+  * If the feature is slated for incorporation into an official analysis, perform tests to show that the overall analysis works and benefits from this feature.
+  * Indicate in this log where to find documentation of the new feature.
+  * Indicate in this log what tests were performed, and where to find a writeup of the results.
+* Fixes to existing features should also be validated.
+  * Perform tests to show that the fix solves the problem that had been indicated.
+  * Perform tests to show that the fix does not cause other problems.
+  * Indicate in this log what tests were performed and how you know the problem was fixed.
+
+Log
+---
+
+Version: 1.2.0
+~~~~~~~~~~~~~~
+
+Release Date: April 5, 2018
+'''''''''''''''''''''''''''''''
+
+New Features:
+'''''''''''''
+
+
+Fixes:
+''''''
+
+* Removing Phylloxera namespace
+* Cleaner PhylloxeraPy interface: prevent libraries from loading twice
+* Cleaner installation: no build of the internal libraries (ToolBox, TritiumSpectrum)
+
+
+Template
+--------
+
+Version: 
+~~~~~~~~
+
+Release Date: 
+'''''''''''''
+
+New Features:
+'''''''''''''
+
+* Feature 1
+    * Details
+* Feature 2
+    * Details
+
+Fixes:
+''''''
+
+* Fix 1
+    * Details
+* Fix 2
+    * Details
+