RED LIST: Check before submitting

[ninamiolane]

What?

This is the list of essentials that need to be checked before submitting the software paper.

• Tests are passing on all repositories.
• Code coverage is above 90% for each of the 3 repositories (see JMLR guidelines).
• The documentation websites look polished for each of the 3 repositories.
• The code snippets given in the README run without problem.
• The three repositories and the pyt-team.github.io repository are packaged into a unique zip file, that is sent to ~5 beta testers with different OS (Mac, Windows, Ubuntu, etc)
• The feedback from the 5 beta testers is addressed.
• The authors are added to the list of authors and they have proof-read the manuscript. This includes the winners of the challenge.

Why?

JMLR guidelines: https://www.jmlr.org/mloss/mloss-info.html

They state, for example: "It is expected that test coverage is close to 100%."