JOSS Review - Comments on Github Repository

[AlexanderJuestel]

This is not a complete list yet

Dear @Patrick-Cole,

please already find some remarks regarding the Repository for your JOSS review at https://github.com/openjournals/joss-reviews/issues/7019

• The Wiki for PyGMI is quite hard to find. I would suggest adding a link in the About section on the right hand side of the repository.
• I would include some keywords in the About section on the right hand side of the repository.
• A citation file is missing.
• A code of conduct file is missing
• A developers guide and/or contributing file is missing, it should also outline if there are any other dependencies you have to install when you want to contribute to PyGMI.
• You provide a pyproject.toml file but users may also want to install the package from a requirements.txt or environment.yml file

Readme:

• The first header should be the name of the package. Currently, it is not machine-readable and limits users with accessibility issues.
• I am missing Badges in the Readme.
• I would add a section with resources explicitly linking to the wiki page of PyGMI and providing links to other necessary files (contributing, developers guide, license)
• I am missing a citation section
• I am missing a reference section

[Patrick-Cole]

I have made the changes here. Two quick questions: 1) Is a citation section necessary on the readme, if it is on the GitHub about section? I have added references. My hope is that the main citation will become the JOSS reference (if accepted). 2) I already have links to the wiki page and license in the readme overview. Did you have something else in mind? I have added contributors her though as well.

I have changes some of the README.rst so that install instructions are hopefully clearer.

[boisgera]

My two cents on the citation (@AlexanderJuestel feel free to disagree!):

1. Is a citation section necessary on the readme, if it is on the GitHub about section? I have added references. My hope is that the main citation will become the JOSS reference (if accepted).

The CITATION.cff file that is automatically picked up as metadata by GitHub is pretty nice! I was not familiar with it, but now I see that some (scikit-learn, pytorch, etc.) are dropping the explicit citation in the README in favor of this metadata. So I'd say that, no, it's not necessary (it may still be beneficial for readers that are not aware of the metadata, but it's a much weaker motivation).

@AlexanderJuestel, can you chime in wrt:

2. I already have links to the wiki page and license in the readme overview. Did you have something else in mind? I have added contributors her though as well.