Reviewer @tianyi93 raised two concerns with CMakePPLang:
The "Statement of Need" section in the README was not as comprehensive as that in the paper. And
There were no instructions for how to run the test suite.
This PR addresses 1 by adding to the "Statement of Need" section a reference to CMake++ and a brief discussion of why we felt it was not sufficient. We did not verbatim copy the JOSS paper's statement of need, but feel that the added verbiage captures the sentiment of the full statement of need found in the JOSS paper. Once the JOSS paper is published we intend to link to it so interested users can read more.
With regards to 2, CMakePPLang is designed to be used as a CMake module so we anticipate that most users will simply include CMakePPLang in their project, and then use it (no testing step). We anticipate that testing of CMakePPLang will primarily be done by CI/CD and CMakePPLang developers, both of whom are expected to follow the developer workflow, not the user workflow. While the developer workflow instructions do state how a developer can test CMakePPLang, these instructions were admittedly quite buried in the documentation. So to address 2 I have added to the "Installation Instructions" section of the README, a direct link to these instructions.
TODOs
@tianyi93 please let us know if these changes sufficiently address your concerns, and if they do not, how we can improve them.
Is this pull request associated with an issue(s)? Please list issues associated with this pull request, including closing words as appropriate.
https://github.com/openjournals/joss-reviews/issues/5711
Description
Reviewer @tianyi93 raised two concerns with CMakePPLang:
This PR addresses 1 by adding to the "Statement of Need" section a reference to CMake++ and a brief discussion of why we felt it was not sufficient. We did not verbatim copy the JOSS paper's statement of need, but feel that the added verbiage captures the sentiment of the full statement of need found in the JOSS paper. Once the JOSS paper is published we intend to link to it so interested users can read more.
With regards to 2, CMakePPLang is designed to be used as a CMake module so we anticipate that most users will simply include CMakePPLang in their project, and then use it (no testing step). We anticipate that testing of CMakePPLang will primarily be done by CI/CD and CMakePPLang developers, both of whom are expected to follow the developer workflow, not the user workflow. While the developer workflow instructions do state how a developer can test CMakePPLang, these instructions were admittedly quite buried in the documentation. So to address 2 I have added to the "Installation Instructions" section of the README, a direct link to these instructions.
TODOs
@tianyi93 please let us know if these changes sufficiently address your concerns, and if they do not, how we can improve them.