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

[REVIEW]: GRLC - the Git Repository Linked data api Constructor #2731

Closed
37 of 40 tasks
whedon opened this issue Oct 7, 2020 · 57 comments
Closed
37 of 40 tasks

[REVIEW]: GRLC - the Git Repository Linked data api Constructor #2731

whedon opened this issue Oct 7, 2020 · 57 comments
Assignees
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Shell TeX

Comments

@whedon
Copy link

whedon commented Oct 7, 2020

Submitting author: @c-martinez (Carlos Martinez-Ortiz)
Repository: https://github.com/CLARIAH/grlc
Version: v1.3.7
Editor: @arfon
Reviewer: @essepuntato, @alexdma
Archive: 10.5281/zenodo.5644276

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

Status

status

Status badge code:

HTML: <a href="https://joss.theoj.org/papers/437074e2d77df8c6cbf3bc4e407b3b17"><img src="https://joss.theoj.org/papers/437074e2d77df8c6cbf3bc4e407b3b17/status.svg"></a>
Markdown: [![status](https://joss.theoj.org/papers/437074e2d77df8c6cbf3bc4e407b3b17/status.svg)](https://joss.theoj.org/papers/437074e2d77df8c6cbf3bc4e407b3b17)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@essepuntato & @alexdma, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @lorenanicole know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Review checklist for @essepuntato

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@c-martinez) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?

Review checklist for @alexdma

Conflict of interest

  • I confirm that I have read the JOSS conflict of interest (COI) policy and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Contribution and authorship: Has the submitting author (@c-martinez) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
  • Substantial scholarly effort: Does this submission meet the scope eligibility described in the JOSS guidelines

Functionality

  • Installation: Does installation proceed as outlined in the documentation?
  • Functionality: Have the functional claims of the software been confirmed?
  • Performance: If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)

Documentation

  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • Installation instructions: Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
  • Example usage: Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • Automated tests: Are there automated tests or manual steps described so that the functionality of the software can be verified?
  • Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

Software paper

  • Summary: Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • State of the field: Do the authors describe how this software compares to other commonly-used packages?
  • Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
  • References: Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper citation syntax?
@whedon
Copy link
Author

whedon commented Oct 7, 2020

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @essepuntato, @alexdma it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSS reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSS is currently operating in a "reduced service mode". You can read more about what that means in our blog post.

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

@whedon
Copy link
Author

whedon commented Oct 7, 2020

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.18174/505685 is OK

MISSING DOIs

- 10.1007/978-3-030-30796-7_28 may be a valid DOI for title: Easy Web API Development with SPARQL Transformer
- 10.1007/978-3-319-47602-5_48 may be a valid DOI for title: grlc Makes GitHub Taste Like Linked Data APIs
- 10.1007/978-3-319-70407-4_27 may be a valid DOI for title: SPARQL2Git: Transparent SPARQL and Linked Data API Curation via Git
- 10.1007/978-3-319-68204-4_30 may be a valid DOI for title: Automatic Query-Centric API for Routine Access to Linked Data

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Oct 7, 2020

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@arfon
Copy link
Member

arfon commented Jan 8, 2021

👋 @essepuntato, @alexdma - happy new year! From the looks of things, neither of you have made any progress on your reviews here. Do you think you might be able to complete your initial review in the next two weeks?

@alexdma
Copy link

alexdma commented Jan 11, 2021

My apologies @arfon - it is certainly no justification that I have moved to a new job and country in the meantime.

I'm trying to work through it but I can't seem to be able to tick any of the checkboxes on my list (code of conduct etc.) - how do I do that? The issue does not seem to be editable.

@arfon
Copy link
Member

arfon commented Jan 11, 2021

@whedon re-invite @alexdma as reviewer

@whedon
Copy link
Author

whedon commented Jan 11, 2021

OK, the reviewer has been re-invited.

@alexdma please accept the invite by clicking this link: https://github.com/openjournals/joss-reviews/invitations

@arfon
Copy link
Member

arfon commented Jan 11, 2021

I'm trying to work through it but I can't seem to be able to tick any of the checkboxes on my list (code of conduct etc.) - how do I do that? The issue does not seem to be editable.

Thanks for the update @alexdma. Please accept the invite from @whedon above and then you should be able to update the checklist.

@alexdma
Copy link

alexdma commented Jan 25, 2021

Hi - Does the Software paper section of the review checklist refer to the article as found here: https://github.com/openjournals/joss-papers/blob/joss.02731/joss.02731/10.21105.joss.02731.pdf ?

Thanks

@arfon
Copy link
Member

arfon commented Jan 25, 2021

Yes, that's correct @alexdma

@alexdma
Copy link

alexdma commented Jan 25, 2021

Thank you @arfon - if I have any recommendation regarding that paper, should the issue be filed with the GRLC code repository or somewhere else?

@arfon
Copy link
Member

arfon commented Jan 25, 2021

@alexdma - please open issues on the associated repository (https://github.com/CLARIAH/grlc) and mention this issue when doing so (#2731), that way they will be cross-linked.

@arfon
Copy link
Member

arfon commented Feb 8, 2021

👋 @essepuntato - just checking in here - do you need any assistance with your review?

@lorenanicole
Copy link

@essepuntato just bumping the below to see if you needed anything additional:

#2731 (comment)

@essepuntato
Copy link

Hi @arfon and @lorenanicole,

I really apologies for my silence - strangely, all your messages went to my SPAM folder and I did not notice them until now. Of course, this is not a justification, since I am tremendously late with the review that, honestly, I totally forgot about it. Thus, please accept my sincere apologies for it.

Back to the topic: I won't be able to address it this week due to prior commitments, but you can expect the review by the end of the next week. Apologies again and have a nice day :-)

@lorenanicole
Copy link

No worries, thank you @essepuntato for the update! Just ping us back on this channel in a week to let us know if you need anything (e.g. more time).

@arfon
Copy link
Member

arfon commented Jun 19, 2021

👋 @essepuntato – just checking in here. Do you think you might be able to provide your review in the next couple of weeks?

@c-martinez
Copy link

@whedon generate pdf

@arfon
Copy link
Member

arfon commented Nov 2, 2021

@c-martinez – At this point could you make a new release of this software that includes the changes that have resulted from this review. Then, please make an archive of the software in Zenodo/figshare/other service and update this thread with the DOI of the archive? For the Zenodo/figshare archive, please make sure that:

  • The title of the archive is the same as the JOSS paper title
  • That the authors of the archive are the same as the JOSS paper authors

I can then move forward with accepting the submission.

@c-martinez
Copy link

Great, thanks @arfon !

I've just made a release in Zenodo

I hope everything is as expected?

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@whedon set 10.5281/zenodo.5644276 as archive

@whedon
Copy link
Author

whedon commented Nov 4, 2021

OK. 10.5281/zenodo.5644276 is the archive.

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@whedon set v1.3.7 as version

@whedon
Copy link
Author

whedon commented Nov 4, 2021

OK. v1.3.7 is the version.

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@whedon check references

@whedon
Copy link
Author

whedon commented Nov 4, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.18174/505685 is OK
- 10.1016/j.websem.2016.03.003 is OK

MISSING DOIs

- 10.1007/978-3-030-30796-7_28 may be a valid DOI for title: Easy Web API Development with SPARQL Transformer
- 10.1007/978-3-319-47602-5_48 may be a valid DOI for title: grlc Makes GitHub Taste Like Linked Data APIs
- 10.1007/978-3-319-70407-4_27 may be a valid DOI for title: SPARQL2Git: Transparent SPARQL and Linked Data API Curation via Git
- 10.1007/978-3-319-68204-4_30 may be a valid DOI for title: Automatic Query-Centric API for Routine Access to Linked Data

INVALID DOIs

- https://doi.org/10.1016/j.websem.2021.100655 is INVALID because of 'https://doi.org/' prefix

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@c-martinez - could you please check if those DOIs recommended by Whedon are correct, and if so, add them to your BibTeX file? Also, this one https://doi.org/10.1016/j.websem.2021.100655 should be written as 10.1016/j.websem.2021.100655 in your BibTeX file please.

@c-martinez
Copy link

Sure no problem -- is a new release necessary after fixing those?

@arfon
Copy link
Member

arfon commented Nov 4, 2021

Sure no problem -- is a new release necessary after fixing those?

No, we can just stick with the same release number and Zenodo archive.

@arfon arfon closed this as completed Nov 4, 2021
@arfon arfon reopened this Nov 4, 2021
@c-martinez
Copy link

Great -- I've added the DOI's recommended by Wheadon.

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@whedon check references

@whedon
Copy link
Author

whedon commented Nov 4, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.websem.2021.100655 is OK
- 10.1007/978-3-030-30796-7_28 is OK
- 10.18174/505685 is OK
- 10.1007/978-3-319-47602-5_48 is OK
- 10.1007/978-3-319-70407-4_27 is OK
- 10.1007/978-3-319-68204-4_30 is OK
- 10.1016/j.websem.2016.03.003 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@whedon recommend-accept

@whedon
Copy link
Author

whedon commented Nov 4, 2021

Attempting dry run of processing paper acceptance...

@whedon whedon added the recommend-accept Papers recommended for acceptance in JOSS. label Nov 4, 2021
@whedon
Copy link
Author

whedon commented Nov 4, 2021

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1016/j.websem.2021.100655 is OK
- 10.1007/978-3-030-30796-7_28 is OK
- 10.18174/505685 is OK
- 10.1007/978-3-319-47602-5_48 is OK
- 10.1007/978-3-319-70407-4_27 is OK
- 10.1007/978-3-319-68204-4_30 is OK
- 10.1016/j.websem.2016.03.003 is OK

MISSING DOIs

- None

INVALID DOIs

- None

@whedon
Copy link
Author

whedon commented Nov 4, 2021

👋 @openjournals/joss-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/joss-papers#2728

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#2728, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@whedon accept deposit=true

@whedon
Copy link
Author

whedon commented Nov 4, 2021

Doing it live! Attempting automated processing of paper acceptance...

@whedon whedon added accepted published Papers published in JOSS labels Nov 4, 2021
@whedon
Copy link
Author

whedon commented Nov 4, 2021

🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦

@whedon
Copy link
Author

whedon commented Nov 4, 2021

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.21105.joss.02731 joss-papers#2729
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/joss.02731
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@arfon
Copy link
Member

arfon commented Nov 4, 2021

@essepuntato, @alexdma – many thanks for your reviews here and to @lorenanicole for editing this submission! JOSS relies upon the volunteer effort of people like you and we simply wouldn't be able to do this without you ✨

@c-martinez – your paper is now accepted and published in JOSS ⚡🚀💥

@arfon arfon closed this as completed Nov 4, 2021
@whedon
Copy link
Author

whedon commented Nov 4, 2021

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02731/status.svg)](https://doi.org/10.21105/joss.02731)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.02731">
  <img src="https://joss.theoj.org/papers/10.21105/joss.02731/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://joss.theoj.org/papers/10.21105/joss.02731/status.svg
   :target: https://doi.org/10.21105/joss.02731

This is how it will look in your documentation:

DOI

We need your help!

Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted published Papers published in JOSS Python recommend-accept Papers recommended for acceptance in JOSS. review Shell TeX
Projects
None yet
Development

No branches or pull requests

6 participants