RED LIST: Check before submitting

Open ninamiolane opened this issue 1 year ago • 0 comments

What?

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

[x] Tests are passing on all repositories.
[x] Code coverage is above 90% for each of the 3 repositories (see JMLR guidelines).
[x] The documentation websites look polished for each of the 3 repositories.
[x] 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.
[x] The authors are added to the list of authors and they have proof-read the manuscript. This includes the winners of the challenge.

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

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

Sep 19 '23 17:09 ninamiolane