Add Release Checklist

Description

Following the discussion on feature testing before handing over to detector scientists, we had agreed to develop a check-list of tests to do.

Here's a preliminary check-list of tests ideas we evaluated and deemed realistic.

I'm not too happy to use RST, but it's the one non-binary format that has decent tables, and I'd like the files to be easily viewable when archived.

Here's a trial I did:

+-----------+------------------------------------------+-------+----------------------+
| Tested By |  Cyril                                   | Date  | 10/10/2020           |
+===========+==========================================+=======+======================+
| Commit Id |  b14786018353dd                                                         |
+-----------+-------------------------------------------------------------------------+
| Detector  |  mini-half                                                              |
+-----------+-------------------------------------------------------------------------+
| Dataset   |  /gpfs/exfel/exp/HED/202031/p900174/raw/r00{10,11,12}                   |
+-----------+--------------------------+-------------------------+--------------------+
| Execution | xfel-calibrate     X     | serve overview          | MyMDC              |
+-----------+--------------------------+-------------------------+--------------------+
+---------------------+------------------+-----------+--------------------------------+
| Procedure           | Expected Results | Pass/Fail | Actual Result/Comments         |
+=====================+==================+===========+================================+
| Job launch                                                                          |
+---------------------+------------------+-----------+--------------------------------|
| Performs primary    | Accepts input    |           | The --modules 0,1,2,3,4,5,6,7  |
| functionality and   | parameters and   |  PASS     | flag was given                 |
| maintains stability | generate report  |           |                                |
+---------------------+------------------+-----------+--------------------------------+
| Darks Creation                                                                      |
+---------------------+------------------+-----------+--------------------------------|
| Verbose fail with   | Message when     |           | The function failed silently   |
| wrong directories   | directories do   |  FAIL     | and the error rose at a later  |
|                     | not contain data |           | stage                          |
+---------------------+------------------+-----------+--------------------------------|
| Verbose fail with   | Message when the |           |                                |
| wrong detector data | detector is not  | PASS      |                                |
|                     | found in data    |           |                                |
+---------------------+------------------+-----------+--------------------------------|
| Output file creation|    Yes           | PASS      |                                |
+---------------------+------------------+-----------+--------------------------------|
| The quantity of     | Only specified   |           |                                |
| processed files     | modules are      |  PASS     |                                |
| matches input params| processed        |           |                                |
+---------------------+------------------+-----------+--------------------------------|
| extra_data check on |                  |  PASS     |                                |
| keys                |                  |           |                                |
+---------------------+------------------+-----------+--------------------------------|
| extra_data check on |                  |  PASS     | 128 × 512 × 352 × 3            |
| shape               |                  |           |                                |
+---------------------+------------------+-----------+--------------------------------|
| extra_data check on |                  |  PASS     | uint32                         |
| dtype               |                  |           |                                |
+---------------------+------------------+-----------+--------------------------------|
| Slurm job elapsed   | jobs are the same|  PASS     | within 9 minutes               |
| time                | magnitude as     |           |                                |
|                     | previous jobs    |           |                                |
+---------------------+------------------+-----------+--------------------------------+
| Darks Creation                                                                      |
+---------------------+------------------+-----------+--------------------------------+
| PDF report created  |                  | PASS      |                                |
+---------------------+------------------+-----------+--------------------------------+
| No errors in files  | Check for lack of| PASS      |                                |
|                     | errors in report |           |                                |
+---------------------+------------------+-----------+--------------------------------+
| PDF report has      | Pipeline inputs  | PASS      |                                |
| correct chapters    | Runtime summary  |           |                                |
|                     | Summary          |           |                                |
+---------------------+------------------+-----------+--------------------------------+

Reviewers

@santosh @ahmedk