CIL sustainability

[paskino]

I ran a Sustainability Evaluation on CIL from the SSI.

Here the results:
https://docs.google.com/document/d/1ds6_kEmdF6eBxfmVdlKLb-t6MtGoyIZJTR0kWPYd9tQ/edit?usp=sharing

I think that we should start with the following (in no particular order):

• documentation:
  • quick start guide,
  • dependency list with versions
  • who is this software for
  • how to get help
• policies
  • contribution policy
  • policy on how to submit issues/PR
  • policy on how to merge PR
• software
  • a script/module that you'd run to test that everything works

Although this may seem too stiff, it would make the work of planning, developing and reviewing simpler.
GitHub allows issue creation with a template. I looked at the ones readily available and they seem a bit too verbose. We need something simpler, IMHO.

We used to have a miniscule developers guide I put together when we started CIL from which we could take some text.
BTW that readthedocs should go.

[DanicaSTFC]

New developers guide
https://tomographicimaging.github.io/CIL/nightly/developer_guide.html