Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

R2.4: Add dependency testing to the automation use case #285

Closed
pedrohbraga opened this issue Nov 17, 2022 · 2 comments · Fixed by #307
Closed

R2.4: Add dependency testing to the automation use case #285

pedrohbraga opened this issue Nov 17, 2022 · 2 comments · Fixed by #307
Assignees
Labels
Reviewer Comment A comment from peer review which requires a response and potentially changes to the manuscript

Comments

@pedrohbraga
Copy link
Contributor

Reviewer 2 comment:

R2.4. I suggest adding a discussion on dependency testing within or following the paragraph on Automation (Lines 373-382). This is a project “ecosystem” phenomenon that comes from collaboration, where you build your project on the work of someone else. As projects change over time, they can alter other projects. Software engineers have been working on this challenge for a long time in distributed teams where different parts of software are being built by different programmers. Checks can be done automatically within the software engineering framework (see Pasquier et al. 2017 https://www.nature.com/articles/sdata2017114). Beyond detection, any major changes can be detected and presented without additional work from the user via features like badges (https://shields.io/) within the project page (e.g., README).

Recommendations during the revision:

  1. When performing changes addressing this comment, please recall this issue (using # followed by the number of this issue) in the pull request; and,
  2. Clearly justify changes in the final comment of the pull request (to allow us to revise the manuscript in time).
@pedrohbraga pedrohbraga added the Reviewer Comment A comment from peer review which requires a response and potentially changes to the manuscript label Nov 17, 2022
@pedrohbraga pedrohbraga self-assigned this Dec 7, 2022
@wavingtowaves
Copy link
Contributor

I do not think we should make this addition. While dependency testing is important for sharing code widely, it falls on the more technical end of the spectrum. We have been encouraged by reviewer 1 in #277 and #278 to reduce jargon and gear our work toward entry-level researchers. Dependency management is out of scope for that group.

@pedrohbraga
Copy link
Contributor Author

Hi. I agree that both automation and unit dependency testing are more advanced tasks, which many users may not require. Still, it has been more and more encouraged as a way to mitigate errors across research practices. The narrative already incorporated these components when we discussed about validation and verification, but perhaps in a less clear way. Without adding complexity to the narrative, I added a few words to mention that automation can aid the testing of research code and the implementation of workflows for the interpretation, integration and usage of data and software across different sources, and included two citations (one of them being the one that the reviewer provided).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Reviewer Comment A comment from peer review which requires a response and potentially changes to the manuscript
Projects
Status: Done
2 participants